@peable.to/shared-types 0.12.0 → 0.13.0

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TAX_LOCATION_EVIDENCE_TYPES = exports.TAX_REGISTRATION_SCHEMES = 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.CATALOG_LIMITS = exports.COUPON_DURATIONS = exports.TRANSFORM_QUANTITY_ROUNDS = exports.PRICE_TAX_BEHAVIORS = exports.RECURRING_USAGE_TYPES = exports.RECURRING_INTERVALS = exports.PRICE_TYPES = exports.PRICE_TIERS_MODES = exports.PRICE_BILLING_SCHEMES = exports.WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS = exports.WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT = exports.WEBHOOK_ENDPOINT_DISABLED_REASONS = exports.WEBHOOK_ENDPOINT_STATUSES = exports.PEABLE_API_VERSION = exports.SETUP_INTENT_STATUSES = exports.isValidStatusTransition = exports.canStillBePaid = exports.canExpire = exports.TERMINAL_STATUSES = exports.PAYMENT_INTENT_STATUSES = exports.PAYMENT_INTENT_SETUP_FUTURE_USAGES = exports.PAYMENT_INTENT_RAILS = exports.PAYMENT_INTENT_CAPTURE_METHODS = exports.PAYMENT_INTENT_CANCELLATION_REASONS = exports.MERCHANT_CANCELLATION_REASONS = exports.EXPIRABLE_STATUSES = exports.CARD_ONLY_STATUSES = exports.isCurrencyCode = exports.decimalsFor = exports.CURRENCY_DECIMALS = exports.CURRENCY_CODES = exports.isBaseUnitString = exports.UNITS_PER_COIN = void 0;
+exports.TAX_LOCATION_EVIDENCE_TYPES = exports.TAX_REGISTRATION_SCHEMES = 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.SIMULATED_FAIRCOIN_OUTCOMES = exports.REQUEST_LOG_RETENTION_DAYS = exports.REQUEST_LOG_METHODS = exports.CATALOG_LIMITS = exports.COUPON_DURATIONS = exports.TRANSFORM_QUANTITY_ROUNDS = exports.PRICE_TAX_BEHAVIORS = exports.RECURRING_USAGE_TYPES = exports.RECURRING_INTERVALS = exports.PRICE_TYPES = exports.PRICE_TIERS_MODES = exports.PRICE_BILLING_SCHEMES = exports.WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS = exports.WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT = exports.WEBHOOK_ENDPOINT_DISABLED_REASONS = exports.WEBHOOK_ENDPOINT_STATUSES = exports.PEABLE_API_VERSION = exports.SETUP_INTENT_STATUSES = exports.isValidStatusTransition = exports.canStillBePaid = exports.canExpire = exports.TERMINAL_STATUSES = exports.PAYMENT_INTENT_STATUSES = exports.PAYMENT_INTENT_SETUP_FUTURE_USAGES = exports.PAYMENT_INTENT_RAILS = exports.PAYMENT_INTENT_CAPTURE_METHODS = exports.PAYMENT_INTENT_CANCELLATION_REASONS = exports.MERCHANT_CANCELLATION_REASONS = exports.EXPIRABLE_STATUSES = exports.CARD_ONLY_STATUSES = 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; } });
@@ -41,6 +41,11 @@ Object.defineProperty(exports, "PRICE_TAX_BEHAVIORS", { enumerable: true, get: f
 Object.defineProperty(exports, "TRANSFORM_QUANTITY_ROUNDS", { enumerable: true, get: function () { return catalog_1.TRANSFORM_QUANTITY_ROUNDS; } });
 Object.defineProperty(exports, "COUPON_DURATIONS", { enumerable: true, get: function () { return catalog_1.COUPON_DURATIONS; } });
 Object.defineProperty(exports, "CATALOG_LIMITS", { enumerable: true, get: function () { return catalog_1.CATALOG_LIMITS; } });
+var requestLog_1 = require("./requestLog");
+Object.defineProperty(exports, "REQUEST_LOG_METHODS", { enumerable: true, get: function () { return requestLog_1.REQUEST_LOG_METHODS; } });
+Object.defineProperty(exports, "REQUEST_LOG_RETENTION_DAYS", { enumerable: true, get: function () { return requestLog_1.REQUEST_LOG_RETENTION_DAYS; } });
+var testHelpers_1 = require("./testHelpers");
+Object.defineProperty(exports, "SIMULATED_FAIRCOIN_OUTCOMES", { enumerable: true, get: function () { return testHelpers_1.SIMULATED_FAIRCOIN_OUTCOMES; } });
 var webhookSigner_1 = require("./webhookSigner");
 Object.defineProperty(exports, "signWebhook", { enumerable: true, get: function () { return webhookSigner_1.signWebhook; } });
 Object.defineProperty(exports, "verifyWebhook", { enumerable: true, get: function () { return webhookSigner_1.verifyWebhook; } });

package/dist/cjs/requestLog.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_LOG_RETENTION_DAYS = exports.REQUEST_LOG_METHODS = void 0;
+/**
+ * One merchant API request, as Peable recorded it (`req_…`) — the request log
+ * Orbit and `peable logs tail` read.
+ *
+ * Its `id` IS the `Request-Id` that request was answered with, so the id a
+ * merchant quotes to support and the log row are the same thing.
+ *
+ * Deliberately thin: method, path (no query string), status, duration and the
+ * `Idempotency-Key` it carried. No body, no headers, no query string, no
+ * caller address — a log a merchant can read is a log that must not hold what
+ * a request carried. Kept 30 days.
+ */
+exports.REQUEST_LOG_METHODS = ['GET', 'POST', 'DELETE', 'PATCH', 'PUT'];
+/** How long a request log is kept (and served). */
+exports.REQUEST_LOG_RETENTION_DAYS = 30;

package/dist/cjs/testHelpers.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Test helpers (`/v1/test_helpers/*`) — test mode only.
+ *
+ * They drive a test-mode object through the SAME state machine a real payment
+ * moves through, so a merchant can exercise their integration end to end
+ * without a wallet or a card: every transition a helper makes is one the
+ * gateway would make, with the same events and webhooks.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SIMULATED_FAIRCOIN_OUTCOMES = void 0;
+/**
+ * What `simulate_faircoin_payment` pretends the payer did.
+ *
+ *  - `settled`   — paid the full amount, which is then seen in the mempool and
+ *    confirmed: `broadcast → confirming → settled`
+ *    (`payment_intent.confirming`, then `payment_intent.settled`).
+ *  - `underpaid` — sent less than the amount: `broadcast → failed`
+ *    (`payment_intent.failed`).
+ */
+exports.SIMULATED_FAIRCOIN_OUTCOMES = ['settled', 'underpaid'];

package/dist/esm/index.js

@@ -5,6 +5,8 @@ export { SETUP_INTENT_STATUSES, } from './setupIntent.js';
 export { PEABLE_API_VERSION, } from './event.js';
 export { WEBHOOK_ENDPOINT_STATUSES, WEBHOOK_ENDPOINT_DISABLED_REASONS, WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT, WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS, } from './webhookEndpoint.js';
 export { PRICE_BILLING_SCHEMES, PRICE_TIERS_MODES, PRICE_TYPES, RECURRING_INTERVALS, RECURRING_USAGE_TYPES, PRICE_TAX_BEHAVIORS, TRANSFORM_QUANTITY_ROUNDS, COUPON_DURATIONS, CATALOG_LIMITS, } from './catalog.js';
+export { REQUEST_LOG_METHODS, REQUEST_LOG_RETENTION_DAYS, } from './requestLog.js';
+export { SIMULATED_FAIRCOIN_OUTCOMES, } from './testHelpers.js';
 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';

package/dist/esm/requestLog.js

@@ -0,0 +1,15 @@
+/**
+ * One merchant API request, as Peable recorded it (`req_…`) — the request log
+ * Orbit and `peable logs tail` read.
+ *
+ * Its `id` IS the `Request-Id` that request was answered with, so the id a
+ * merchant quotes to support and the log row are the same thing.
+ *
+ * Deliberately thin: method, path (no query string), status, duration and the
+ * `Idempotency-Key` it carried. No body, no headers, no query string, no
+ * caller address — a log a merchant can read is a log that must not hold what
+ * a request carried. Kept 30 days.
+ */
+export const REQUEST_LOG_METHODS = ['GET', 'POST', 'DELETE', 'PATCH', 'PUT'];
+/** How long a request log is kept (and served). */
+export const REQUEST_LOG_RETENTION_DAYS = 30;

package/dist/esm/testHelpers.js

@@ -0,0 +1,18 @@
+/**
+ * Test helpers (`/v1/test_helpers/*`) — test mode only.
+ *
+ * They drive a test-mode object through the SAME state machine a real payment
+ * moves through, so a merchant can exercise their integration end to end
+ * without a wallet or a card: every transition a helper makes is one the
+ * gateway would make, with the same events and webhooks.
+ */
+/**
+ * What `simulate_faircoin_payment` pretends the payer did.
+ *
+ *  - `settled`   — paid the full amount, which is then seen in the mempool and
+ *    confirmed: `broadcast → confirming → settled`
+ *    (`payment_intent.confirming`, then `payment_intent.settled`).
+ *  - `underpaid` — sent less than the amount: `broadcast → failed`
+ *    (`payment_intent.failed`).
+ */
+export const SIMULATED_FAIRCOIN_OUTCOMES = ['settled', 'underpaid'];

package/dist/types/index.d.ts

@@ -12,6 +12,8 @@ export { PRICE_BILLING_SCHEMES, PRICE_TIERS_MODES, PRICE_TYPES, RECURRING_INTERV
 export type { Dispute, DisputeEvidence, DisputeStatus } from './dispute';
 export type { CapabilityStatus, ConnectedAccount, ConnectedAccountFaircoin, ConnectedAccountFaircoinStatus, ConnectedAccountRail, Refund, RefundOrigin, RefundStatus, Settlement, Transfer, TransferReversal, TransferReversalStatus, TransferStatus, TransferWithReversal, } from './settlement';
 export type { WebhookDelivery, WebhookDeliveryStatus, } from './webhookDelivery';
+export { REQUEST_LOG_METHODS, REQUEST_LOG_RETENTION_DAYS, type RequestLog, type RequestLogListParams, type RequestLogMethod, type RequestLogStatusFilter, } from './requestLog';
+export { SIMULATED_FAIRCOIN_OUTCOMES, type SimulatedFaircoinOutcome, type SimulateFaircoinPaymentParams, } from './testHelpers';
 export { signWebhook, verifyWebhook } from './webhookSigner';
 export { type MerchantEnvironment, type Merchant, MERCHANT_ENVIRONMENTS, } from './merchant';
 export type { MerchantDisplay } from './merchantDisplay';

package/dist/types/requestLog.d.ts

@@ -0,0 +1,40 @@
+import type { ListParams } from './list';
+/**
+ * One merchant API request, as Peable recorded it (`req_…`) — the request log
+ * Orbit and `peable logs tail` read.
+ *
+ * Its `id` IS the `Request-Id` that request was answered with, so the id a
+ * merchant quotes to support and the log row are the same thing.
+ *
+ * Deliberately thin: method, path (no query string), status, duration and the
+ * `Idempotency-Key` it carried. No body, no headers, no query string, no
+ * caller address — a log a merchant can read is a log that must not hold what
+ * a request carried. Kept 30 days.
+ */
+export declare const REQUEST_LOG_METHODS: readonly ["GET", "POST", "DELETE", "PATCH", "PUT"];
+export type RequestLogMethod = (typeof REQUEST_LOG_METHODS)[number];
+export interface RequestLog {
+    /** The request's `Request-Id` (`req_…`). */
+    id: string;
+    object: 'request_log';
+    livemode: boolean;
+    method: RequestLogMethod;
+    /** The path that was requested, without its query string. */
+    path: string;
+    /** The HTTP status it was answered with. */
+    status: number;
+    /** How long the gateway took to answer, in milliseconds. */
+    duration_ms: number;
+    /** The `Idempotency-Key` the request carried, if it carried a valid one. */
+    idempotency_key: string | null;
+    /** When it was answered, Unix seconds. */
+    created: number;
+}
+/** `status`: one code (`404`) or a class (`2xx`, `4xx`, `5xx`). */
+export type RequestLogStatusFilter = number | '2xx' | '3xx' | '4xx' | '5xx';
+export interface RequestLogListParams extends ListParams {
+    status?: RequestLogStatusFilter;
+    method?: RequestLogMethod;
+}
+/** How long a request log is kept (and served). */
+export declare const REQUEST_LOG_RETENTION_DAYS = 30;

package/dist/types/testHelpers.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Test helpers (`/v1/test_helpers/*`) — test mode only.
+ *
+ * They drive a test-mode object through the SAME state machine a real payment
+ * moves through, so a merchant can exercise their integration end to end
+ * without a wallet or a card: every transition a helper makes is one the
+ * gateway would make, with the same events and webhooks.
+ */
+/**
+ * What `simulate_faircoin_payment` pretends the payer did.
+ *
+ *  - `settled`   — paid the full amount, which is then seen in the mempool and
+ *    confirmed: `broadcast → confirming → settled`
+ *    (`payment_intent.confirming`, then `payment_intent.settled`).
+ *  - `underpaid` — sent less than the amount: `broadcast → failed`
+ *    (`payment_intent.failed`).
+ */
+export declare const SIMULATED_FAIRCOIN_OUTCOMES: readonly ["settled", "underpaid"];
+export type SimulatedFaircoinOutcome = (typeof SIMULATED_FAIRCOIN_OUTCOMES)[number];
+export interface SimulateFaircoinPaymentParams {
+    /** Default `settled`. */
+    outcome?: SimulatedFaircoinOutcome;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/shared-types",
-  "version": "0.12.0",
+  "version": "0.13.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",