@peable.to/shared-types 0.3.3-oxy-one.0 → 0.3.4

package/dist/types/billing.d.ts

@@ -53,6 +53,8 @@ export interface BillingCheckoutSession extends BillingHostedSession {
     id: string;
 }
 export interface BillingCheckoutObservation {
+    /** Immutable subscription_create invoice proven for this exact checkout. Discovery only, never paid authority. */
+    initialInvoiceId: string | null;
     id: string;
     status: 'open' | 'complete' | 'expired';
     storeId: string;
@@ -221,3 +223,43 @@ export interface BillingTaxQuote {
         value: string;
     };
 }
+/** Read-only recovery of one previously attempted recurring checkout. Neither
+ * absence nor uncertainty permits cancellation or another financial operation. */
+export interface RetrieveBillingCheckoutOperationParams {
+    idempotencyKey: string;
+    providerCustomerId: string;
+    providerPriceId: string;
+    storeId: string;
+    planId: string;
+}
+export interface BillingCheckoutOperationSource extends RetrieveBillingCheckoutOperationParams {
+    taxQuoteId: string | null;
+    merchantId: string;
+    appId: string;
+    mode: 'test' | 'live';
+    environment: 'development' | 'staging' | 'production';
+}
+export type BillingCheckoutOperationRecovery = {
+    state: 'not_found' | 'pending' | 'indeterminate';
+    source: BillingCheckoutOperationSource;
+} | {
+    state: 'succeeded';
+    source: BillingCheckoutOperationSource;
+    checkout: {
+        id: string;
+        expiresAt: string;
+        url?: string;
+    };
+};
+export interface BillingFaircoinFxQuote {
+    id: string;
+    currency: 'USD';
+    grossMinorUnits: number;
+    amountBaseUnits: string;
+    usdPerFair: string;
+    source: string;
+    observedAt: string;
+    quotedAt: string;
+    expiresAt: string;
+    rounding: 'ceil_to_base_unit';
+}

package/dist/types/checkoutSession.d.ts

@@ -1,3 +1,4 @@
+import type { BillingFaircoinFxQuote } from './billing';
 import type { CurrencyCode } from './money';
 import type { NetworkType } from './network';
 import type { MerchantDisplay } from './merchantDisplay';
@@ -29,6 +30,8 @@ export interface CheckoutSession {
  * `clientSecret`, which the page needs to open the socket and to `submit_tx`.
  */
 export interface CheckoutSessionPublic {
+    /** Frozen commercial USD price and exact FAIR settlement quote; no payer metadata. */
+    billingQuote?: BillingFaircoinFxQuote;
     id: string;
     object: 'checkout_session';
     successUrl?: string;

package/dist/types/index.d.ts

@@ -1,15 +1,16 @@
 export { UNITS_PER_COIN, isBaseUnitString, type CurrencyCode, CURRENCY_CODES, CURRENCY_DECIMALS, decimalsFor, isCurrencyCode, } from './money';
-export { type NetworkType } from './network';
+export type { NetworkType } from './network';
 export { type PaymentIntentStatus, type PaymentIntentRail, type PaymentIntent, type CreatePaymentIntentParams, isValidStatusTransition, canStillBePaid, reachesSettlementFromPayer, POST_SETTLEMENT_STATUSES, PAYMENT_INTENT_STATUSES, PAYMENT_INTENT_RAILS, CHAIN_ONLY_STATUSES, CARD_ONLY_STATUSES, } from './paymentIntent';
-export { type WebhookEventType, type WebhookEvent, type WebhookEventPayload, type BillingObservation, } from './event';
-export { type Dispute, type DisputeEvidence, type DisputeStatus } from './dispute';
-export { type CapabilityStatus, type ConnectedAccount, type Refund, type RefundOrigin, type RefundStatus, type Settlement, type Transfer, type TransferReversal, type TransferReversalStatus, type TransferStatus, type TransferWithReversal, } from './settlement';
-export { type WebhookDelivery, type WebhookDeliveryStatus, } from './webhookDelivery';
+export type { WebhookEventType, WebhookEvent, WebhookEventPayload, BillingObservation, } from './event';
+export type { Dispute, DisputeEvidence, DisputeStatus } from './dispute';
+export type { CapabilityStatus, ConnectedAccount, Refund, RefundOrigin, RefundStatus, Settlement, Transfer, TransferReversal, TransferReversalStatus, TransferStatus, TransferWithReversal, } from './settlement';
+export type { WebhookDelivery, WebhookDeliveryStatus, } from './webhookDelivery';
 export { signWebhook, verifyWebhook } from './webhookSigner';
 export { type MerchantEnvironment, type Merchant, MERCHANT_ENVIRONMENTS, } from './merchant';
-export { type MerchantDisplay } from './merchantDisplay';
-export { type PaymentLink, type PublicPaymentLink, type CreatePaymentLinkParams, } from './paymentLink';
-export { type CheckoutSession, type CheckoutSessionPublic, type CreateCheckoutSessionParams, } from './checkoutSession';
+export type { MerchantDisplay } from './merchantDisplay';
+export type { PaymentLink, PublicPaymentLink, CreatePaymentLinkParams, } from './paymentLink';
+export type { CheckoutSession, CheckoutSessionPublic, CreateCheckoutSessionParams, } 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 BillingPaidInvoice, type BillingInvoiceState, type BillingCustomer, 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 BillingCheckoutObservation, type RetrieveBillingCheckoutOperationParams, type BillingCheckoutOperationSource, type BillingCheckoutOperationRecovery, type BillingPaidInvoice, type BillingInvoiceState, type BillingCustomer, type EnsureBillingCustomerParams, type CreateBillingCheckoutParams, type CreateBillingPortalParams, type BillingHostedSession, type BillingSubscription, } from './billing';
 export { canonicalBillingAuthority, canonicalBillingTaxQuote } from './billing-authority';
+export type { BillingFaircoinFxQuote } from './billing';

package/dist/types/paymentLink.d.ts

@@ -1,3 +1,4 @@
+import type { ContributionDetails } from '@peable.to/contracts';
 import type { CurrencyCode } from './money';
 import type { NetworkType } from './network';
 import type { MerchantDisplay } from './merchantDisplay';
@@ -6,6 +7,7 @@ import type { PaymentIntentRail } from './paymentIntent';
 export interface PaymentLink {
     id: string;
     object: 'payment_link';
+    contribution?: ContributionDetails;
     /**
      * Amount in the currency's smallest unit, as a canonical integer string.
      * Never a float, and never interpretable without `currency`.
@@ -28,6 +30,7 @@ export interface PaymentLink {
 export interface PublicPaymentLink {
     id: string;
     object: 'payment_link';
+    contribution?: ContributionDetails;
     amount: string;
     currency: CurrencyCode;
     rail: PaymentIntentRail;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/shared-types",
-  "version": "0.3.3-oxy-one.0",
+  "version": "0.3.4",
   "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",
@@ -9,8 +9,7 @@
   "sideEffects": false,
   "publishConfig": {
     "access": "public",
-    "registry": "https://registry.npmjs.org/",
-    "tag": "oxy-one"
+    "registry": "https://registry.npmjs.org/"
   },
   "exports": {
     ".": {
@@ -62,5 +61,8 @@
     "typescript": "~5.9.2",
     "@types/node": "^20.0.0",
     "@types/bun": "latest"
+  },
+  "dependencies": {
+    "@peable.to/contracts": "0.1.0"
   }
 }