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

package/dist/cjs/billing-authority.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PEABLE_BILLING_AUTHORITY_KEYS = void 0;
 exports.canonicalBillingAuthority = canonicalBillingAuthority;
 exports.canonicalBillingTaxQuote = canonicalBillingTaxQuote;
 /** Canonical JSON v1: lexicographic object keys, array order preserved, UTF-8.
@@ -37,3 +38,17 @@ function canonicalBillingTaxQuote(authority) {
         quote: authority.quote,
     });
 }
+/**
+ * The PUBLIC halves of the Ed25519 keys production Peable signs billing
+ * authority with (signed tax quotes and final invoice authorities), by key id.
+ * Pin these as the SDK's `invoiceAuthorityKeys` / `taxQuoteAuthorityKeys`.
+ *
+ * The private halves exist only in Peable's production secret store and reach
+ * the gateway as a mounted file (`PEABLE_BILLING_INVOICE_PRIVATE_KEY_FILE`); the
+ * gateway refuses to sign with a key whose public half is not listed here. A
+ * rotation adds the new id beside the old one, and the old id is removed only
+ * after every authority it signed has been consumed.
+ */
+exports.PEABLE_BILLING_AUTHORITY_KEYS = Object.freeze({
+    'peable-billing-2026-10': '-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAt6lkqirzUxlnt22igH+lRWW7+dRRlk4QK0a2wIKfnCA=\n-----END PUBLIC KEY-----\n',
+});

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.canonicalBillingTaxQuote = exports.canonicalBillingAuthority = exports.BILLING_SUBSCRIPTION_STATUSES = exports.SOCIAL_SOURCE_REF_MAX_LENGTH = exports.SOCIAL_SOURCE_APP_MAX_LENGTH = exports.MERCHANT_ENVIRONMENTS = exports.verifyWebhook = exports.signWebhook = exports.CARD_ONLY_STATUSES = exports.CHAIN_ONLY_STATUSES = exports.PAYMENT_INTENT_RAILS = exports.PAYMENT_INTENT_STATUSES = exports.POST_SETTLEMENT_STATUSES = exports.reachesSettlementFromPayer = exports.canStillBePaid = exports.isValidStatusTransition = exports.isCurrencyCode = exports.decimalsFor = exports.CURRENCY_DECIMALS = exports.CURRENCY_CODES = exports.isBaseUnitString = exports.UNITS_PER_COIN = void 0;
+exports.PEABLE_BILLING_AUTHORITY_KEYS = exports.canonicalBillingTaxQuote = exports.canonicalBillingAuthority = exports.BILLING_SUBSCRIPTION_STATUSES = exports.SOCIAL_SOURCE_REF_MAX_LENGTH = exports.SOCIAL_SOURCE_APP_MAX_LENGTH = exports.MERCHANT_ENVIRONMENTS = exports.verifyWebhook = exports.signWebhook = exports.CARD_ONLY_STATUSES = exports.CHAIN_ONLY_STATUSES = exports.PAYMENT_INTENT_RAILS = exports.PAYMENT_INTENT_STATUSES = exports.POST_SETTLEMENT_STATUSES = exports.reachesSettlementFromPayer = exports.canStillBePaid = exports.isValidStatusTransition = exports.isCurrencyCode = exports.decimalsFor = exports.CURRENCY_DECIMALS = exports.CURRENCY_CODES = exports.isBaseUnitString = exports.UNITS_PER_COIN = void 0;
 // @peable.to/shared-types — public API for the Peable Gateway contract.
 var money_1 = require("./money");
 Object.defineProperty(exports, "UNITS_PER_COIN", { enumerable: true, get: function () { return money_1.UNITS_PER_COIN; } });
@@ -31,3 +31,4 @@ Object.defineProperty(exports, "BILLING_SUBSCRIPTION_STATUSES", { enumerable: tr
 var billing_authority_1 = require("./billing-authority");
 Object.defineProperty(exports, "canonicalBillingAuthority", { enumerable: true, get: function () { return billing_authority_1.canonicalBillingAuthority; } });
 Object.defineProperty(exports, "canonicalBillingTaxQuote", { enumerable: true, get: function () { return billing_authority_1.canonicalBillingTaxQuote; } });
+Object.defineProperty(exports, "PEABLE_BILLING_AUTHORITY_KEYS", { enumerable: true, get: function () { return billing_authority_1.PEABLE_BILLING_AUTHORITY_KEYS; } });

package/dist/esm/billing-authority.js

@@ -33,3 +33,17 @@ export function canonicalBillingTaxQuote(authority) {
         quote: authority.quote,
     });
 }
+/**
+ * The PUBLIC halves of the Ed25519 keys production Peable signs billing
+ * authority with (signed tax quotes and final invoice authorities), by key id.
+ * Pin these as the SDK's `invoiceAuthorityKeys` / `taxQuoteAuthorityKeys`.
+ *
+ * The private halves exist only in Peable's production secret store and reach
+ * the gateway as a mounted file (`PEABLE_BILLING_INVOICE_PRIVATE_KEY_FILE`); the
+ * gateway refuses to sign with a key whose public half is not listed here. A
+ * rotation adds the new id beside the old one, and the old id is removed only
+ * after every authority it signed has been consumed.
+ */
+export const PEABLE_BILLING_AUTHORITY_KEYS = Object.freeze({
+    'peable-billing-2026-10': '-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAt6lkqirzUxlnt22igH+lRWW7+dRRlk4QK0a2wIKfnCA=\n-----END PUBLIC KEY-----\n',
+});

package/dist/esm/index.js

@@ -5,4 +5,4 @@ export { signWebhook, verifyWebhook } from './webhookSigner.js';
 export { MERCHANT_ENVIRONMENTS, } from './merchant.js';
 export { SOCIAL_SOURCE_APP_MAX_LENGTH, SOCIAL_SOURCE_REF_MAX_LENGTH, } from './social.js';
 export { BILLING_SUBSCRIPTION_STATUSES, } from './billing.js';
-export { canonicalBillingAuthority, canonicalBillingTaxQuote } from './billing-authority.js';
+export { canonicalBillingAuthority, canonicalBillingTaxQuote, PEABLE_BILLING_AUTHORITY_KEYS, } from './billing-authority.js';

package/dist/types/billing-authority.d.ts

@@ -1,3 +1,15 @@
 import type { BillingFinalInvoiceAuthority, BillingTaxQuote } from './billing';
 export declare function canonicalBillingAuthority(authority: Pick<BillingFinalInvoiceAuthority, 'schemaVersion' | 'source' | 'invoice' | 'method'>): string;
 export declare function canonicalBillingTaxQuote(authority: Pick<BillingTaxQuote, 'schemaVersion' | 'source' | 'quote'>): string;
+/**
+ * The PUBLIC halves of the Ed25519 keys production Peable signs billing
+ * authority with (signed tax quotes and final invoice authorities), by key id.
+ * Pin these as the SDK's `invoiceAuthorityKeys` / `taxQuoteAuthorityKeys`.
+ *
+ * The private halves exist only in Peable's production secret store and reach
+ * the gateway as a mounted file (`PEABLE_BILLING_INVOICE_PRIVATE_KEY_FILE`); the
+ * gateway refuses to sign with a key whose public half is not listed here. A
+ * rotation adds the new id beside the old one, and the old id is removed only
+ * after every authority it signed has been consumed.
+ */
+export declare const PEABLE_BILLING_AUTHORITY_KEYS: Readonly<Record<string, string>>;

package/dist/types/billing.d.ts

@@ -5,11 +5,49 @@ export type BillingSubscriptionStatus = (typeof BILLING_SUBSCRIPTION_STATUSES)[n
 export interface BillingCustomer {
     providerCustomerId: string;
 }
+/** A settlement rail a merchant's recurring offers can be paid through. `stripe`
+ * (and any further fiat provider) settles in fiat; `faircoin` settles natively
+ * to the merchant's watch-only wallet. One merchant may offer several rails at
+ * once and the payer chooses; every rail answers through the same subscription,
+ * invoice and authority contracts below. */
+export type BillingRail = 'stripe' | 'faircoin' | (string & {});
+export type BillingRailSettlement = 'fiat' | 'faircoin';
+/** One offer a rail can sell. Fiat provider rails bind their prices from the
+ * app's own provider catalogue, so they list `offers: null`. */
+export interface BillingRailOffer {
+    providerPriceId: string;
+    planId: string;
+    interval: 'month' | 'year';
+    currency: string;
+    grossMinorUnits: number;
+    taxTreatment: 'inclusive' | 'exclusive';
+}
+export interface BillingRailOption {
+    rail: BillingRail;
+    settlement: BillingRailSettlement;
+    /** The rail a request that names none is served by: the first configured. */
+    default: boolean;
+    /** Whether `createTaxQuote` is answered for this rail. */
+    taxQuotes: boolean;
+    /** `automatic`: the provider charges each period. `payer_initiated`: each
+     * period is an explicit payment through `renewSubscription`. */
+    renewal: 'automatic' | 'payer_initiated';
+    offers: BillingRailOffer[] | null;
+}
+export interface BillingRailList {
+    object: 'list';
+    data: BillingRailOption[];
+}
 export interface EnsureBillingCustomerParams {
     storeId: string;
     storeName: string;
+    /** The payer's chosen rail. Omitted: the merchant's default rail. A customer
+     * belongs to one rail, and its checkouts and subscriptions follow it. */
+    rail?: BillingRail;
 }
 export interface CreateBillingCheckoutParams {
+    /** Optional assertion of the rail; it must be the rail of `providerCustomerId`. */
+    rail?: BillingRail;
     /** Opt-in fiscal checkout. The full signed quote is immutable and single-use.
      * Requires a trusted Peable adapter capable of applying these exact amounts. */
     taxQuote?: BillingTaxQuote;
@@ -185,6 +223,8 @@ export interface BillingFaircoinRenewalRevocation {
 /** A merchant asks Peable to quote a registered product. Monetary/fiscal
  * configuration is resolved inside Peable, never supplied by a consumer. */
 export interface CreateBillingTaxQuoteParams {
+    /** Omitted: the first of the merchant's rails that answers tax quotes. */
+    rail?: BillingRail;
     storeId: string;
     planId: string;
     customerLocationEvidenceId: string;

package/dist/types/index.d.ts

@@ -11,6 +11,6 @@ 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 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 { 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 { canonicalBillingAuthority, canonicalBillingTaxQuote, PEABLE_BILLING_AUTHORITY_KEYS, } from './billing-authority';
 export type { BillingFaircoinFxQuote } from './billing';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/shared-types",
-  "version": "0.3.4-oxy-one.0",
+  "version": "0.4.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",
@@ -9,8 +9,7 @@
   "sideEffects": false,
   "publishConfig": {
     "access": "public",
-    "registry": "https://registry.npmjs.org/",
-    "tag": "oxy-one"
+    "registry": "https://registry.npmjs.org/"
   },
   "exports": {
     ".": {