@agent-cards/sdk 0.23.28 → 0.24.1

package/dist/buy.js

@@ -1,39 +1,28 @@
 /**
  * The buy module of the SDK: `agentcard.buy.*`. The Purchase API from the
- * same client the voice module uses: one pair of client credentials, one
+ * same client the checkout module uses: one pair of client credentials, one
  * token. A business asks for a cart on behalf of a person it connected,
  * confirms the cart by its hash, and, when it already holds an approval the
- * person gave by voice, names that approval on the confirm so the API places
+ * person gave, names that approval on the confirm so the API places
  * against it and asks the person for nothing a second time (decision 234).
- * With `approval: 'voice'` the confirm asks the API to mint the purchase's
- * own approval instead of an approval page, the business runs the key word
- * in its app on that id, and the same confirm placed again completes the
- * order (decision 237).
  *
  * Every call names `user_id`, the person the connect exchange returned, so a
  * server serving many people never buys for the wrong one. A person who is
  * not connected to this client is refused with `user_not_connected`.
  */
 import { ApiModule } from './api-module.js';
-import { AgentcardError } from './voice-types.js';
-/** The one refusal a store makes under `approval: 'voice'`: its connector cannot place under a voice verdict, and the business takes its own path. A 409, as `BuyError.code`. */
-export const VOICE_EXECUTION_UNSUPPORTED = 'voice_execution_unsupported';
+import { AgentcardError } from './api-types.js';
 /** True for a turn the API declined; `decline_code` says why (it is null when the loop refused in prose only). */
 export function isBuyDeclined(turn) { return turn.status === 'declined'; }
-/** True for a confirm waiting for the person's verdict by voice; `authorization_id` is the id your app runs the key word on. */
-export function isBuyNeedsApproval(turn) { return turn.status === 'needs_approval' && typeof turn.authorization_id === 'string'; }
-/** True when the store could not place under a voice verdict; `error` is the refusal. */
-export function isBuyVoiceUnsupported(turn) { return turn.status === VOICE_EXECUTION_UNSUPPORTED; }
 /**
  * A refusal from the Purchase API, as an `AgentcardError` whose `code` is the
  * API's (`user_not_connected`, `authorization_not_approved`,
  * `authorization_mismatch`, `authorization_spent`, `turn_in_progress`,
  * `delivery_address_changed`, `cart_changed`, `nothing_to_confirm`,
- * `conversation_not_found`, `conversation_closed`,
- * `voice_execution_unsupported`) or the client's own before any call
+ * `conversation_not_found`, `conversation_closed`) or the client's own before any call
  * (`not_connected`, `invalid_ask`, `invalid_cart_hash`,
- * `invalid_authorization_id`, `invalid_payment_source`, `invalid_approval`,
- * `missing_conversation_id`, `missing_authorization_id`). `carts` carries the
+ * `invalid_authorization_id`, `invalid_payment_source`,
+ * `missing_conversation_id`). `carts` carries the
  * carts as they stand when the refusal named them, so a confirm of a changed
  * cart reads the fresh hash from the error.
  */
@@ -69,13 +58,21 @@ function cartOf(v) {
         merchant_name: typeof c.merchant_name === 'string' ? c.merchant_name : c.merchant,
         store: storeOf(c.store),
         items: Array.isArray(c.items) ? c.items : [],
-        serviceFeesCents: typeof c.serviceFeesCents === 'number' ? c.serviceFeesCents : 0,
+        ...feesOf(c),
         tipCents: typeof c.tipCents === 'number' ? c.tipCents : 0,
         totalCents: typeof c.totalCents === 'number' ? c.totalCents : 0,
         approvedCeilingCents: typeof c.approvedCeilingCents === 'number' ? c.approvedCeilingCents : null,
         hash: c.hash,
     };
 }
+/** A pending or unreadable fee stays null with its status, so it never reads as a genuine zero. */
+function feesOf(c) {
+    const amount = typeof c.serviceFeesCents === 'number' ? c.serviceFeesCents : null;
+    const status = c.merchantFeesPending === true || c.serviceFeesStatus === 'pending' ? 'pending'
+        : (c.serviceFeesStatus === undefined || c.serviceFeesStatus === 'known')
+            && amount !== null && Number.isSafeInteger(amount) && amount >= 0 ? 'known' : 'unknown';
+    return { serviceFeesCents: status === 'known' ? amount : null, serviceFeesStatus: status };
+}
 function storeOf(v) {
     if (!v || typeof v !== 'object')
         return null;
@@ -113,7 +110,7 @@ function outcomeOf(a) {
         authorization_id: str(a.authorization_id),
     };
 }
-const STATUSES = new Set(['needs_input', 'needs_approval', 'order_placed', 'partially_placed', 'declined', 'approved_not_charged']);
+const STATUSES = new Set(['needs_input', 'order_placed', 'partially_placed', 'declined', 'approved_not_charged']);
 function statusOf(v) { return typeof v === 'string' && STATUSES.has(v) ? v : 'needs_input'; }
 function placementsOf(v) {
     if (!Array.isArray(v))
@@ -215,8 +212,8 @@ export class BuyModule extends ApiModule {
     }
     /**
      * Places the cart the person saw, by its hash, for the person `user_id`
-     * names. With `authorization_id`, the approval the person already gave by
-     * voice for this purchase, the API places against that approval and asks
+     * names. With `authorization_id`, the approval the person already gave
+     * for this purchase, the API places against that approval and asks
      * for nothing a second time; the answer carries `authorization_id` back.
      * Without it the confirm runs as before: the person's rules, or the
      * approval the API asks for on `approval_url`. A cart that changed since
@@ -232,11 +229,9 @@ export class BuyModule extends ApiModule {
         if (hashes.length === 0 || hashes.some((h) => typeof h !== 'string' || !CART_HASH.test(h)))
             refuse('invalid_cart_hash', 'confirm must be a cart hash from a previous turn (turn.cart.hash), or a list of them.');
         if (input.authorization_id !== undefined && (typeof input.authorization_id !== 'string' || !/^cauth_/.test(input.authorization_id)))
-            refuse('invalid_authorization_id', 'authorization_id must be the approval voice.authorizations.create minted (cauth_…).');
+            refuse('invalid_authorization_id', 'authorization_id must be the approval you hold for this purchase (cauth_…).');
         if (input.payment_source !== undefined && input.payment_source !== 'vault')
             refuse('invalid_payment_source', "payment_source must be 'vault' when named.");
-        if (input.approval !== undefined && input.approval !== 'voice' && input.approval !== 'page')
-            refuse('invalid_approval', "approval must be 'voice' or 'page' when named.");
         const body = {
             user_id,
             conversation_id,
@@ -244,60 +239,10 @@ export class BuyModule extends ApiModule {
             ...(input.authorization_id ? { authorization_id: input.authorization_id } : {}),
             ...(input.delivery_address ? { delivery_address: input.delivery_address } : {}),
             ...(input.payment_source ? { payment_source: input.payment_source } : {}),
-            ...(input.approval ? { approval: input.approval } : {}),
             ...(input.wait === true ? { wait: true } : {}),
         };
         return this.turn(body, input.timeout_ms);
     }
-    /**
-     * The whole approval by voice, for a business whose app holds the person:
-     * confirms the cart with the person's own card and `approval: 'voice'`,
-     * hands the `authorization_id` the API minted to your `challenge` (your
-     * app runs the key word on it; you resolve when the verdict is in), then
-     * sends the same confirm again and returns what it answered:
-     * `order_placed` with `order_id`, `declined` with `voice_declined` or
-     * `approval_expired`, or `needs_approval` again when the verdict was still
-     * out. A store whose connector cannot place under a voice verdict is
-     * returned as `status: 'voice_execution_unsupported'`, not thrown, so the
-     * business falls back to its own path; every other refusal throws as
-     * `buy.confirm` does. A first confirm the API completes without asking (a
-     * rule took it, or it declined outright) is returned as it came and
-     * `challenge` is never called. Two confirms at most; nothing is polled.
-     */
-    async approveByVoice(input) {
-        if (typeof input?.challenge !== 'function')
-            refuse('invalid_challenge', 'Name challenge: the function that runs the key word in your app on the authorization_id and resolves when the verdict is in.');
-        const confirm = {
-            user_id: input.user_id, conversation_id: input.conversation_id, confirm: input.confirm,
-            ...(input.delivery_address ? { delivery_address: input.delivery_address } : {}),
-            payment_source: 'vault', approval: 'voice', ...(input.timeout_ms !== undefined ? { timeout_ms: input.timeout_ms } : {}),
-        };
-        const unsupported = (err, authorization_id) => err instanceof BuyError && err.code === VOICE_EXECUTION_UNSUPPORTED ? { status: VOICE_EXECUTION_UNSUPPORTED, conversation_id: err.conversation_id ?? input.conversation_id, authorization_id, error: err } : null;
-        let first;
-        try {
-            first = await this.confirm(confirm);
-        }
-        catch (err) {
-            const u = unsupported(err, null);
-            if (u)
-                return u;
-            throw err;
-        }
-        if (first.status !== 'needs_approval')
-            return first;
-        if (!isBuyNeedsApproval(first))
-            refuse('missing_authorization_id', 'The API asked for an approval by voice but named no authorization_id to run it on.');
-        await input.challenge(first.authorization_id, first);
-        try {
-            return await this.confirm(confirm);
-        }
-        catch (err) {
-            const u = unsupported(err, first.authorization_id);
-            if (u)
-                return u;
-            throw err;
-        }
-    }
     /**
      * One read of a conversation, with no wait: whether a turn is still
      * running, the last checkout attempt, every order it placed from the

package/dist/capabilities.generated.js

@@ -1,3 +1,3 @@
 // Written by scripts/generate-capabilities.mjs from capabilities.json. Do not edit; git ignores it.
 /** capabilities.json's list, sorted; client.ts exports it as SUPPORTED_CAPABILITIES. */
-export const DECLARED_CAPABILITIES = ["aci_split_card.v1", "amadeus_checkout_actions.v1", "aps_custom_merchant_page", "authorize_net_dpm_form", "barion_hosted_payment_page", "capture_context", "clover_card_token", "comgate_hosted_payment_page", "converge_hpp_process", "creditguard_pps_process", "cybersource_sa_token_create", "datatrans_secure_fields_tokenize", "ekashu_hosted_payment_page", "eximbay_hosted_payment_page", "fastspring_card_payment", "fiserv_card_capture", "gmo_shared_pk", "gopay_card_form", "gravy_session_fields_put", "hipay_vault_token", "juspay_txns.v1", "lyra_krypton_payment", "makecommerce_card_frame", "midtrans_card_token", "moneris_hosted_tokenization", "nexi_checkout_pay", "omise_card_token", "openpay_tokenizer", "paddle_tokenex_pay", "paddle_vgs_cards", "pay_nl_card_token", "payfast_card_pay", "paygent_token", "paymob_checkout_pay", "paymongo_checkout_pay", "paypal_card_fields", "payrails_device_encrypt", "payrexx_card_frame", "paytrail_hosted_payment_page", "payu_latam_webcheckout_card", "pelecard_transaction", "pin_payments_card_token", "poynt_collect_nonce", "primer_payment_instruments", "przelewy24_hosted_payment_page", "quickpay_hosted_payment_page", "redsys_hosted_payment_page", "revolut_card_field", "sbps_token_jsonp", "shiji_sts_pinned_key", "sumup_checkout_process", "tap_card_sdk_token", "toast_pinned_key", "tokenex_iframe_tokenize", "transbank_webpay_hosted_payment_page", "twoc2p_secure_pay", "verifone_card_capture", "wix_payments_tokenize", "worldline_mycheckout_form", "worldpay_eprotect_jsonp", "wspay_confirm", "xendit_card_token"];
+export const DECLARED_CAPABILITIES = ["aci_split_card.v1", "amadeus_checkout_actions.v1", "aps_custom_merchant_page", "aurus_one_time_token", "authorize_net_dpm_form", "barion_hosted_payment_page", "bluesnap_hosted_payment_fields", "capture_context", "cardlink_vpos_hosted_payment_page", "clover_card_token", "comgate_hosted_payment_page", "converge_hpp_process", "creditguard_pps_process", "cybersource_sa_token_create", "datatrans_secure_fields_tokenize", "eghl_hosted_payment_page", "ekashu_hosted_payment_page", "eximbay_hosted_payment_page", "fastspring_card_payment", "fiserv_card_capture", "frisbii_card_token", "gmo_shared_pk", "gopay_card_form", "gravy_session_fields_put", "hipay_vault_token", "iyzico_checkout_form", "juspay_txns.v1", "lyra_krypton_payment", "makecommerce_card_frame", "midtrans_card_token", "monei_card_token", "moneris_hosted_tokenization", "nexi_checkout_pay", "oceanpayment_hosted_payment_page", "omise_card_token", "openpay_tokenizer", "paddle_tokenex_pay", "paddle_vgs_cards", "pay_nl_card_token", "payfast_card_pay", "paygent_token", "paymentwall_card_token", "paymob_checkout_pay", "paymongo_checkout_pay", "paypal_card_fields", "payplug_hosted_payment_page", "payrails_device_encrypt", "payrexx_card_frame", "paystack_pinned_key", "paytrail_hosted_payment_page", "payu_latam_webcheckout_card", "pelecard_transaction", "pin_payments_card_token", "poynt_collect_nonce", "primer_payment_instruments", "processout_card_token", "przelewy24_hosted_payment_page", "quickpay_hosted_payment_page", "redsys_hosted_payment_page", "revolut_card_field", "sbps_token_jsonp", "shiji_sts_pinned_key", "sumup_checkout_process", "tap_card_sdk_token", "toast_pinned_key", "tokenex_iframe_tokenize", "transbank_webpay_hosted_payment_page", "twoc2p_secure_pay", "usaepay_payment_key", "verifone_card_capture", "viva_smart_checkout_chargetoken", "vtex_payments_card_payment", "wix_payments_tokenize", "worldline_mycheckout_form", "worldpay_eprotect_jsonp", "wspay_confirm", "xendit_card_token"];