@peable.to/shared-types 0.7.0 → 0.9.0

package/dist/types/billing.d.ts

@@ -310,3 +310,45 @@ export interface BillingFaircoinFxQuote {
     expires_at: number;
     rounding: 'ceil_to_base_unit';
 }
+/** Durable embedded-session reference. Provider secrets are never persisted in it. */
+export interface BillingEmbeddedCheckoutSession {
+    id: string;
+    presentation: 'embedded';
+    expires_at: number;
+}
+/** Ephemeral processor capability released only to the authenticated owning workload. */
+export interface BillingEmbeddedCheckoutAction {
+    kind: 'checkout_session';
+    provider: 'stripe';
+    session_id: string;
+    client_secret: string;
+    publishable_key: string;
+    amount_minor_units: number;
+    currency: string;
+}
+export interface BillingEmbeddedCheckoutScope {
+    merchant_id: string;
+    app_id: string;
+    environment: 'development' | 'staging' | 'production';
+    mode: 'test' | 'live';
+}
+export interface BillingEmbeddedCheckoutConfiguration {
+    scope: BillingEmbeddedCheckoutScope;
+    publishable_key: string;
+    payment_methods: {
+        id: 'card';
+        available: boolean;
+    }[];
+}
+export interface BillingEmbeddedCheckoutBinding {
+    status: 'open' | 'complete' | 'expired';
+    action: BillingEmbeddedCheckoutAction | null;
+    scope: BillingEmbeddedCheckoutScope & {
+        store_id: string;
+        plan_id: string;
+        provider_customer_id: string;
+        provider_price_id: string;
+    };
+    tax_quote: BillingTaxQuote;
+    expires_at: number;
+}

package/dist/types/checkoutSession.d.ts

@@ -8,6 +8,11 @@ import type { ConnectedAccount } from './settlement';
 export interface CheckoutSession {
     id: string;
     object: 'checkout_session';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     /** The wrapped payment's `pi_…`, or the {@link PaymentIntent} with `expand[]=payment_intent`. */
     payment_intent: string | PaymentIntent;
     /** The wrapped intent's `client_secret`, returned to the merchant on create. */
@@ -41,6 +46,11 @@ export interface CheckoutSessionPublic {
     billing_quote?: BillingFaircoinFxQuote;
     id: string;
     object: 'checkout_session';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     success_url?: string;
     cancel_url?: string;
     merchant: MerchantDisplay;

package/dist/types/connect.d.ts

@@ -34,6 +34,11 @@ export interface ConnectOnboardingComplete {
  */
 export interface AccountLink {
     object: 'account_link';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     url: string;
     expires_at: number;
 }

package/dist/types/dispute.d.ts

@@ -26,6 +26,11 @@ export type DisputeStatus = 'needs_response' | 'under_review' | 'won' | 'lost';
 export interface Dispute {
     id: string;
     object: 'dispute';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     /** The disputed payment's `pi_…`, or the {@link PaymentIntent} with `expand[]=payment_intent`. */
     payment_intent: string | PaymentIntent;
     /**

package/dist/types/event.d.ts

@@ -71,6 +71,8 @@ export type WebhookEventType = 'payment_intent.confirming' | 'payment_intent.set
 /** Wake-up only. Re-read the owner-bound SDK resource; this is never paid or grant authority. */
 export interface BillingObservation {
     object: 'billing_observation';
+    /** The mode of the billing cohort observed (ADR 0017). */
+    livemode: boolean;
     resource_kind: 'subscription' | 'invoice';
     resource_id: string;
     revision: number;
@@ -115,6 +117,8 @@ export type WebhookEvent<K extends WebhookEventType = WebhookEventType> = {
     [T in K]: {
         id: string;
         object: 'event';
+        /** The mode of the merchant it was sent to, and of the object it carries (ADR 0017). */
+        livemode: boolean;
         type: T;
         created: number;
         /**

package/dist/types/index.d.ts

@@ -13,7 +13,7 @@ export type { AccountLink, ConnectOnboarding, ConnectOnboardingComplete, Registe
 export type { PaymentLink, PublicPaymentLink, CreatePaymentLinkParams, UpdatePaymentLinkParams, } from './paymentLink';
 export type { CheckoutSession, CheckoutSessionPublic, CreateCheckoutSessionParams, UpdateCheckoutSessionParams, } from './checkoutSession';
 export { SOCIAL_SOURCE_APP_MAX_LENGTH, SOCIAL_SOURCE_REF_MAX_LENGTH, type SocialPaymentSource, type SocialNextAddressRequest, type SocialNextAddressResponse, type SocialReceiveCursorResponse, type SocialPaymentDirection, type SocialPayment, type SocialPaymentsResponse, type EnrichmentKind, type EnrichmentResult, type EnrichRequest, type EnrichResponse, } from './social';
-export { BILLING_SUBSCRIPTION_STATUSES, type BillingSubscriptionStatus, type CreateBillingTaxQuoteParams, type BillingTaxQuote, type BillingInvoiceAuthoritySource, type BillingFinalInvoice, type BillingFinalInvoiceAuthority, type BillingFaircoinRenewalChoice, type BillingFaircoinRenewalConsent, type BillingFaircoinRenewalRevocation, type BillingCheckoutSession, type BillingCheckoutObservation, type RetrieveBillingCheckoutOperationParams, type BillingCheckoutOperationSource, type BillingCheckoutOperationRecovery, type BillingPaidInvoice, type BillingInvoiceState, type BillingCustomer, type BillingRail, type BillingRailSettlement, type BillingRailOffer, type BillingRailOption, type BillingRailList, type EnsureBillingCustomerParams, type CreateBillingCheckoutParams, type CreateBillingPortalParams, type BillingHostedSession, type BillingSubscription, } from './billing';
+export { BILLING_SUBSCRIPTION_STATUSES, type BillingSubscriptionStatus, type CreateBillingTaxQuoteParams, type BillingTaxQuote, type BillingInvoiceAuthoritySource, type BillingFinalInvoice, type BillingFinalInvoiceAuthority, type BillingFaircoinRenewalChoice, type BillingFaircoinRenewalConsent, type BillingFaircoinRenewalRevocation, type BillingCheckoutSession, type BillingEmbeddedCheckoutSession, type BillingEmbeddedCheckoutConfiguration, type BillingEmbeddedCheckoutBinding, type BillingEmbeddedCheckoutAction, type BillingEmbeddedCheckoutScope, type BillingCheckoutObservation, type RetrieveBillingCheckoutOperationParams, type BillingCheckoutOperationSource, type BillingCheckoutOperationRecovery, type BillingPaidInvoice, type BillingInvoiceState, type BillingCustomer, type BillingRail, type BillingRailSettlement, type BillingRailOffer, type BillingRailOption, type BillingRailList, type EnsureBillingCustomerParams, type CreateBillingCheckoutParams, type CreateBillingPortalParams, type BillingHostedSession, type BillingSubscription, } from './billing';
 export { canonicalBillingAuthority, canonicalBillingTaxQuote, PEABLE_BILLING_AUTHORITY_KEYS, } from './billing-authority';
 export type { BillingFaircoinFxQuote } from './billing';
 export { TAX_REGISTRATION_SCHEMES, TAX_LOCATION_EVIDENCE_TYPES, type TaxRegistrationScheme, type TaxLocationEvidenceType, type TaxBehavior, type TaxAddress, type TaxCode, type TaxCalculationAccount, type TaxSettings, type UpdateTaxSettingsParams, type TaxRegistration, type CreateTaxRegistrationParams, type TaxProductCode, type TaxLocationEvidenceItem, type CreateTaxLocationEvidenceParams, type TaxLocationEvidence, type TaxLineItemParams, type CreateTaxCalculationParams, type TaxBreakdownEntry, type TaxCalculationLineItem, type TaxCalculation, type TaxTransaction, type TaxTransactionList, type TaxTransactionReversal, type CreateTaxReversalParams, type ListTaxTransactionsParams, type TaxReportRow, type TaxReport, type BillingInvoiceTaxLine, } from './tax';

package/dist/types/merchant.d.ts

@@ -4,6 +4,11 @@ export type MerchantEnvironment = (typeof MERCHANT_ENVIRONMENTS)[number];
 export interface Merchant {
     id: string;
     object: 'merchant';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     oxy_app_id: string;
     environment: MerchantEnvironment;
     /**

package/dist/types/paymentIntent.d.ts

@@ -73,6 +73,11 @@ export declare function canExpire(status: PaymentIntentStatus): boolean;
 export interface PaymentIntent {
     id: string;
     object: 'payment_intent';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     status: PaymentIntentStatus;
     /** Which rail moves this payment. Decides which fields below are populated. */
     rail: PaymentIntentRail;

package/dist/types/paymentLink.d.ts

@@ -7,6 +7,11 @@ import type { PaymentIntentRail } from './paymentIntent';
 export interface PaymentLink {
     id: string;
     object: 'payment_link';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     contribution?: ContributionDetails;
     /**
      * Amount in the currency's smallest unit, as a canonical integer string.
@@ -30,6 +35,11 @@ export interface PaymentLink {
 export interface PublicPaymentLink {
     id: string;
     object: 'payment_link';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     contribution?: ContributionDetails;
     amount: string;
     currency: CurrencyCode;

package/dist/types/settlement.d.ts

@@ -43,6 +43,11 @@ export interface ConnectedAccountFaircoin {
 export interface ConnectedAccount {
     id: string;
     object: 'connected_account';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     /** The merchant's OWN id for this seller — how they address it. */
     external_ref: string;
     /** Which halves this account has. Never empty. */
@@ -97,6 +102,11 @@ export interface ConnectedAccount {
 export interface Transfer {
     id: string;
     object: 'transfer';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     /** The merchant's OWN id for what this settles. Their idempotency. */
     external_ref: string;
     /** The seller's `ca_…` — never their account id at the provider — or the object, expanded. */
@@ -128,6 +138,11 @@ export interface Transfer {
 export interface TransferReversal {
     id: string;
     object: 'transfer_reversal';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     /** The merchant's own id for this reversal — their `Idempotency-Key`. */
     external_ref: string;
     amount: string;
@@ -164,6 +179,11 @@ export interface TransferWithReversal extends Transfer {
  */
 export interface Settlement {
     object: 'settlement';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     /** The `pi_…` this describes, or the {@link PaymentIntent} with `expand[]=payment_intent`. */
     payment_intent: string | PaymentIntent;
     /**
@@ -196,6 +216,11 @@ export type RefundOrigin = 'merchant' | 'provider';
 export interface Refund {
     id: string;
     object: 'refund';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     /** `null` on an IMPORTED refund; see {@link RefundOrigin}. */
     external_ref: string | null;
     origin: RefundOrigin;

package/dist/types/webhookDelivery.d.ts

@@ -22,6 +22,11 @@ export type WebhookDeliveryStatus = 'pending' | 'delivered' | 'failed' | 'dead';
 export interface WebhookDelivery {
     id: string;
     object: 'webhook_delivery';
+    /**
+     * Which of the provider's two worlds this object belongs to (ADR 0017):
+     * `true` for a `production` merchant, `false` for every other environment.
+     */
+    livemode: boolean;
     merchant_id: string;
     /**
      * The `pi_…` this delivery is about — `null` when the event is not about a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/shared-types",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Shared TypeScript types for the Peable Gateway — the wire contract shared by the backend, SDK, and frontend.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",