@peable.to/shared-types 0.3.1-oxy-one.0 → 0.3.2-oxy-one.0

package/dist/cjs/billing-authority.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.canonicalBillingAuthority = canonicalBillingAuthority;
+exports.canonicalBillingTaxQuote = canonicalBillingTaxQuote;
+/** Canonical JSON v1: lexicographic object keys, array order preserved, UTF-8.
+ * Only finite safe integer amounts and plain JSON values are permitted. */
+function encode(value) {
+    if (value === null || typeof value === 'string' || typeof value === 'boolean')
+        return JSON.stringify(value);
+    if (typeof value === 'number' && Number.isSafeInteger(value))
+        return JSON.stringify(value);
+    if (Array.isArray(value))
+        return `[${value.map(encode).join(',')}]`;
+    if (typeof value !== 'object' || value === null || Object.getPrototypeOf(value) !== Object.prototype)
+        throw new Error('Invalid authority JSON');
+    const object = value;
+    return `{${Object.keys(object).sort().filter((key) => object[key] !== undefined).map((key) => `${JSON.stringify(key)}:${encode(object[key])}`).join(',')}}`;
+}
+function canonicalBillingAuthority(authority) {
+    return encode({ schemaVersion: authority.schemaVersion, source: authority.source, invoice: authority.invoice, method: authority.method });
+}
+function canonicalBillingTaxQuote(authority) {
+    return encode({ schemaVersion: authority.schemaVersion, source: authority.source, quote: authority.quote });
+}

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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; } });
@@ -28,3 +28,6 @@ Object.defineProperty(exports, "SOCIAL_SOURCE_APP_MAX_LENGTH", { enumerable: tru
 Object.defineProperty(exports, "SOCIAL_SOURCE_REF_MAX_LENGTH", { enumerable: true, get: function () { return social_1.SOCIAL_SOURCE_REF_MAX_LENGTH; } });
 var billing_1 = require("./billing");
 Object.defineProperty(exports, "BILLING_SUBSCRIPTION_STATUSES", { enumerable: true, get: function () { return billing_1.BILLING_SUBSCRIPTION_STATUSES; } });
+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; } });

package/dist/esm/billing-authority.js

@@ -0,0 +1,20 @@
+/** Canonical JSON v1: lexicographic object keys, array order preserved, UTF-8.
+ * Only finite safe integer amounts and plain JSON values are permitted. */
+function encode(value) {
+    if (value === null || typeof value === 'string' || typeof value === 'boolean')
+        return JSON.stringify(value);
+    if (typeof value === 'number' && Number.isSafeInteger(value))
+        return JSON.stringify(value);
+    if (Array.isArray(value))
+        return `[${value.map(encode).join(',')}]`;
+    if (typeof value !== 'object' || value === null || Object.getPrototypeOf(value) !== Object.prototype)
+        throw new Error('Invalid authority JSON');
+    const object = value;
+    return `{${Object.keys(object).sort().filter((key) => object[key] !== undefined).map((key) => `${JSON.stringify(key)}:${encode(object[key])}`).join(',')}}`;
+}
+export function canonicalBillingAuthority(authority) {
+    return encode({ schemaVersion: authority.schemaVersion, source: authority.source, invoice: authority.invoice, method: authority.method });
+}
+export function canonicalBillingTaxQuote(authority) {
+    return encode({ schemaVersion: authority.schemaVersion, source: authority.source, quote: authority.quote });
+}

package/dist/esm/index.js

@@ -5,3 +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';

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

@@ -0,0 +1,3 @@
+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;

package/dist/types/billing.d.ts

@@ -84,3 +84,137 @@ export interface BillingPaidInvoice {
     paidAt: string;
     observedAt: string;
 }
+/** Provider-independent fiscal evidence. Values come from the configured authority,
+ * never from invoice amounts, merchant metadata, or an application tax guess. */
+export interface BillingInvoiceAuthoritySource {
+    invoiceId: string;
+    paymentIntentId: string;
+    customerId: string;
+    subscriptionId: string;
+    priceId: string;
+    planId: string;
+    merchantId: string;
+    appId: string;
+    mode: 'test' | 'live';
+    environment: 'development' | 'staging' | 'production';
+}
+export interface BillingFinalInvoice {
+    platform: 'peable';
+    currency: string;
+    grossMinorUnits: number;
+    netMinorUnits: number;
+    taxMinorUnits: number;
+    merchantFeeMinorUnits: number;
+    taxTreatment: 'inclusive' | 'exclusive';
+    sellerId: string;
+    invoiceIssuerId: string;
+    taxQuoteId: string;
+    customerLocationEvidenceId: string;
+    taxRateEvidenceId: string;
+    context: {
+        payerAccountId: string;
+        beneficiaryAccountId: string;
+        providerSubscriptionId: string;
+        offerId: string;
+        offerVersion: number;
+        periodStart: string;
+        periodEnd: string;
+        mode: 'test' | 'live';
+        environment: 'development' | 'staging' | 'production';
+    };
+    issuedAt: string;
+    expiresAt: string;
+    faircoinQuote?: {
+        id: string;
+        amountBaseUnits: string;
+        quotedAt: string;
+        expiresAt: string;
+        roundingEvidenceId: string;
+    };
+}
+export interface BillingFinalInvoiceAuthority {
+    schemaVersion: 1;
+    source: BillingInvoiceAuthoritySource;
+    invoice: BillingFinalInvoice;
+    method: 'card' | 'faircoin';
+    /** Versioned canonical payload: source, invoice and method after strict schema parsing. */
+    signature: {
+        algorithm: 'Ed25519';
+        keyId: string;
+        value: string;
+    };
+}
+/** An automatic renewal authorization is an explicit, bounded instruction.
+ * Transporting it does not create a mandate or authorize custody of payer keys. */
+export type BillingFaircoinRenewalChoice = {
+    method: 'faircoin';
+    renewal: 'manual_monthly';
+} | {
+    method: 'faircoin';
+    renewal: 'automatic';
+    consent: BillingFaircoinRenewalConsent;
+};
+export interface BillingFaircoinRenewalConsent {
+    authorizationId: string;
+    payerAccountId: string;
+    merchantId: string;
+    appId: string;
+    subscriptionId: string;
+    planId: string;
+    mode: 'test' | 'live';
+    environment: 'development' | 'staging' | 'production';
+    explicitConsent: true;
+    consentEvidenceId: string;
+    maximumAmountBaseUnits: string;
+    interval: 'month';
+    intervalCount: 1;
+    startsAt: string;
+    expiresAt: string;
+    acceptedAt: string;
+}
+export interface BillingFaircoinRenewalRevocation {
+    authorizationId: string;
+    revokedAt: string;
+    revocationEvidenceId: string;
+}
+/** A merchant asks Peable to quote a registered product. Monetary/fiscal
+ * configuration is resolved inside Peable, never supplied by a consumer. */
+export interface CreateBillingTaxQuoteParams {
+    storeId: string;
+    planId: string;
+    customerLocationEvidenceId: string;
+}
+export interface BillingTaxQuote {
+    schemaVersion: 1;
+    source: {
+        merchantId: string;
+        appId: string;
+        storeId: string;
+        planId: string;
+        mode: 'test' | 'live';
+        environment: 'development' | 'staging' | 'production';
+    };
+    quote: {
+        id: string;
+        currency: string;
+        grossMinorUnits: number;
+        netMinorUnits: number;
+        taxMinorUnits: number;
+        taxTreatment: 'inclusive' | 'exclusive';
+        sellerId: string;
+        invoiceIssuerId: string;
+        taxRemitterId: string;
+        taxServiceRef: string;
+        country: string;
+        coverageEvidenceId: string;
+        taxRateEvidenceId: string;
+        customerLocationEvidenceId: string;
+        quotedAt: string;
+        expiresAt: string;
+    };
+    signature: {
+        algorithm: 'Ed25519';
+        keyId: string;
+        value: string;
+    };
+}

package/dist/types/index.d.ts

@@ -11,4 +11,5 @@ export { type MerchantDisplay } from './merchantDisplay';
 export { type PaymentLink, type PublicPaymentLink, type CreatePaymentLinkParams, } from './paymentLink';
 export { type CheckoutSession, type CheckoutSessionPublic, type 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 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 BillingPaidInvoice, type BillingInvoiceState, type BillingCustomer, type EnsureBillingCustomerParams, type CreateBillingCheckoutParams, type CreateBillingPortalParams, type BillingHostedSession, type BillingSubscription, } from './billing';
+export { canonicalBillingAuthority, canonicalBillingTaxQuote } from './billing-authority';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/shared-types",
-  "version": "0.3.1-oxy-one.0",
+  "version": "0.3.2-oxy-one.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",