@lunora/payment 1.0.0-alpha.8 → 1.0.0-alpha.80
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +6 -0
- package/README.md +5 -2
- package/dist/index.d.mts +308 -527
- package/dist/index.d.ts +308 -527
- package/dist/index.mjs +1 -16
- package/dist/packem_shared/LunoraPaymentError-BSxyhWgu.mjs +1 -0
- package/dist/packem_shared/MemoryPaymentStore-C2iTSo5g.mjs +1 -0
- package/dist/packem_shared/PAYMENT_TERMINAL_STATES-DVerjPR6.mjs +1 -0
- package/dist/packem_shared/adapter.d-ov0kaEhj.d.mts +445 -0
- package/dist/packem_shared/adapter.d-ov0kaEhj.d.ts +445 -0
- package/dist/packem_shared/addMoney-B4ufWAnD.mjs +1 -0
- package/dist/packem_shared/applyWebhookAction-daHKTG_Q.mjs +1 -0
- package/dist/packem_shared/constantTimeEqual-Bj5tU-zT.mjs +1 -0
- package/dist/packem_shared/createAdapterRegistry-DyCsry1Q.mjs +1 -0
- package/dist/packem_shared/createDatabasePaymentStore-BlMXuCW_.mjs +1 -0
- package/dist/packem_shared/createPayment-Dmh6IWLZ.mjs +1 -0
- package/dist/packem_shared/entitlementsForReference-Bq-9UUL8.mjs +1 -0
- package/dist/packem_shared/idempotencyKey-BjxjMMna.mjs +1 -0
- package/dist/packem_shared/json-BJJPJVYj.mjs +1 -0
- package/dist/packem_shared/lunoraDatabaseToPaymentDatabase-DBveGQxx.mjs +1 -0
- package/dist/packem_shared/not-supported-Cl0brzhn.mjs +1 -0
- package/dist/packem_shared/observability-BteZ2dJS.mjs +1 -0
- package/dist/packem_shared/paymentTables-Be-_11ux.mjs +1 -0
- package/dist/packem_shared/reconcile-Dq48_gHU.mjs +1 -0
- package/dist/packem_shared/subscription-event-C8GiQSFM.mjs +1 -0
- package/dist/providers/autumn-features.d.mts +129 -0
- package/dist/providers/autumn-features.d.ts +129 -0
- package/dist/providers/autumn-features.mjs +1 -0
- package/dist/providers/autumn.d.mts +28 -0
- package/dist/providers/autumn.d.ts +28 -0
- package/dist/providers/autumn.mjs +1 -0
- package/dist/providers/creem.d.mts +26 -0
- package/dist/providers/creem.d.ts +26 -0
- package/dist/providers/creem.mjs +1 -0
- package/dist/providers/dodopayments.d.mts +30 -0
- package/dist/providers/dodopayments.d.ts +30 -0
- package/dist/providers/dodopayments.mjs +1 -0
- package/dist/providers/polar.d.mts +31 -0
- package/dist/providers/polar.d.ts +31 -0
- package/dist/providers/polar.mjs +1 -0
- package/dist/providers/stripe.d.mts +32 -0
- package/dist/providers/stripe.d.ts +32 -0
- package/dist/providers/stripe.mjs +1 -0
- package/package.json +45 -4
- package/dist/packem_shared/LunoraPaymentError-B3hEzXSs.mjs +0 -22
- package/dist/packem_shared/MemoryPaymentStore-DvgdWa3C.mjs +0 -72
- package/dist/packem_shared/PAYMENT_TERMINAL_STATES-DrxV0clv.mjs +0 -26
- package/dist/packem_shared/addMoney-bCcs1nyw.mjs +0 -60
- package/dist/packem_shared/applyWebhookAction-DpAqf3Lw.mjs +0 -177
- package/dist/packem_shared/constantTimeEqual-CfY0jYcL.mjs +0 -95
- package/dist/packem_shared/createAdapterRegistry-BuDHFCBc.mjs +0 -24
- package/dist/packem_shared/createDatabasePaymentStore-bYB_HUE6.mjs +0 -172
- package/dist/packem_shared/createPayment-BccfPGyw.mjs +0 -190
- package/dist/packem_shared/createPolarAdapter-BJtVGSlF.mjs +0 -217
- package/dist/packem_shared/createStripeAdapter-D40MVBXg.mjs +0 -270
- package/dist/packem_shared/entitlementsForReference-CzZGXPoZ.mjs +0 -51
- package/dist/packem_shared/idempotencyKey-BFzDCA7g.mjs +0 -3
- package/dist/packem_shared/json-Db337f36.mjs +0 -6
- package/dist/packem_shared/lunoraDatabaseToPaymentDatabase-RlKX3Kcd.mjs +0 -29
- package/dist/packem_shared/observability-CvhJ205g.mjs +0 -11
- package/dist/packem_shared/paymentTables-DccHwWr_.mjs +0 -127
- package/dist/packem_shared/reconcile-CI1ukJF9.mjs +0 -73
package/dist/index.d.mts
CHANGED
|
@@ -1,327 +1,64 @@
|
|
|
1
|
+
import { a as ProviderId, C as Customer, b as PaymentSession, S as Subscription, U as UsageEvent, W as WebhookActionType, A as ApplyResult, P as PaymentAdapter, c as AttachInput, d as CheckoutResult, e as CancelSubscriptionOptions, f as CaptureInput, g as CheckInput, h as CheckResult, i as CheckoutInput, F as FeatureBalance, R as RefundInput, T as TrackInput, j as TrackResult, k as CurrencyCode, M as Money, l as PaymentState, m as SubscriptionState, n as WebhookAction } from "./packem_shared/adapter.d-ov0kaEhj.mjs";
|
|
2
|
+
export { type o as AdapterRegistry, type p as CustomerRef, type q as PortalInput, type r as ProviderCapabilities, type s as RefundAmountKind, type t as ReportUsageInput, type u as SubscriptionPatch, type v as WebhookHeaders, type w as WebhookInput, x as createAdapterRegistry } from "./packem_shared/adapter.d-ov0kaEhj.mjs";
|
|
3
|
+
import { LunoraError } from '@lunora/errors';
|
|
1
4
|
import { TableDefinition } from '@lunora/server';
|
|
2
5
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
|
|
6
|
-
* provider-agnostic vocabulary every adapter normalizes onto.
|
|
7
|
-
*/
|
|
8
|
-
/** ISO-4217 currency code (uppercase, 3 letters). Not enumerated — provider coverage varies. */
|
|
9
|
-
type CurrencyCode = string;
|
|
10
|
-
/**
|
|
11
|
-
* Money as integer minor units + currency. Always carry the two together.
|
|
12
|
-
*
|
|
13
|
-
* `minorUnits` is a `bigint`, which is **not** JSON-serializable — cross the RPC/wire boundary
|
|
14
|
-
* with the `toMoneyJSON` / `fromMoneyJSON` helpers (see `./money`).
|
|
15
|
-
*/
|
|
16
|
-
interface Money {
|
|
17
|
-
readonly currency: CurrencyCode;
|
|
18
|
-
readonly minorUnits: bigint;
|
|
19
|
-
}
|
|
20
|
-
/** Stable provider identifier (Medusa-style). Scoped to what Convex ships: Stripe + Polar. */
|
|
21
|
-
type ProviderId = "polar" | "stripe";
|
|
22
|
-
/** What a provider can do — encoded in types so tax/UX assumptions aren't tribal knowledge. */
|
|
23
|
-
interface ProviderCapabilities {
|
|
24
|
-
/** True for Polar / Lemon Squeezy / Paddle; false for Stripe (PSP). Drives tax/invoice ownership. */
|
|
25
|
-
readonly merchantOfRecord: boolean;
|
|
26
|
-
/** Native hosted customer/billing portal. */
|
|
27
|
-
readonly portal: boolean;
|
|
28
|
-
/** Usage-based / metered billing. */
|
|
29
|
-
readonly usageMetering: boolean;
|
|
30
|
-
}
|
|
31
|
-
/** Lifecycle state of a one-time payment session. */
|
|
32
|
-
type PaymentState = "authorized" | "canceled" | "captured" | "failed" | "initiated" | "partially_refunded" | "refunded";
|
|
33
|
-
/** Lifecycle state of a subscription. */
|
|
34
|
-
type SubscriptionState = "active" | "canceled" | "past_due" | "paused" | "trialing";
|
|
35
|
-
interface Customer {
|
|
36
|
-
readonly createdAt: number;
|
|
37
|
-
readonly email?: string;
|
|
38
|
-
/** Provider-side customer id. */
|
|
39
|
-
readonly id: string;
|
|
40
|
-
readonly provider: ProviderId;
|
|
41
|
-
/** App-side owner the customer belongs to (user / org / workspace). Opaque to this package. */
|
|
42
|
-
readonly referenceId: string;
|
|
43
|
-
}
|
|
44
|
-
interface PaymentSession {
|
|
45
|
-
readonly amount: Money;
|
|
46
|
-
readonly capturedAmount: Money;
|
|
47
|
-
readonly createdAt: number;
|
|
48
|
-
/** Provider-side payment / intent / session id. */
|
|
49
|
-
readonly id: string;
|
|
50
|
-
readonly provider: ProviderId;
|
|
51
|
-
readonly referenceId: string;
|
|
52
|
-
readonly refundedAmount: Money;
|
|
53
|
-
readonly state: PaymentState;
|
|
54
|
-
readonly updatedAt: number;
|
|
55
|
-
}
|
|
56
|
-
interface Subscription {
|
|
57
|
-
readonly cancelAtPeriodEnd: boolean;
|
|
58
|
-
readonly createdAt: number;
|
|
59
|
-
readonly currentPeriodEnd?: number;
|
|
60
|
-
/** Start of the current billing period — the window `check` sums metered usage over. */
|
|
61
|
-
readonly currentPeriodStart?: number;
|
|
62
|
-
readonly id: string;
|
|
63
|
-
readonly priceId: string;
|
|
64
|
-
readonly provider: ProviderId;
|
|
65
|
-
readonly quantity: number;
|
|
66
|
-
readonly referenceId: string;
|
|
67
|
-
readonly state: SubscriptionState;
|
|
68
|
-
readonly updatedAt: number;
|
|
69
|
-
}
|
|
70
|
-
interface CustomerRef {
|
|
71
|
-
readonly email?: string;
|
|
72
|
-
readonly metadata?: Record<string, string>;
|
|
73
|
-
readonly referenceId: string;
|
|
74
|
-
}
|
|
75
|
-
interface CheckoutInput {
|
|
76
|
-
readonly cancelUrl: string;
|
|
77
|
-
/** Existing provider customer id, if known. */
|
|
78
|
-
readonly customerId?: string;
|
|
79
|
-
/** Outbound idempotency key for the provider call; auto-derived when omitted. */
|
|
80
|
-
readonly idempotencyKey?: string;
|
|
81
|
-
readonly metadata?: Record<string, string>;
|
|
82
|
-
readonly mode: "payment" | "subscription";
|
|
83
|
-
readonly priceId: string;
|
|
84
|
-
readonly quantity?: number;
|
|
85
|
-
readonly referenceId: string;
|
|
86
|
-
readonly successUrl: string;
|
|
87
|
-
}
|
|
88
|
-
interface CheckoutResult {
|
|
89
|
-
readonly id: string;
|
|
90
|
-
readonly provider: ProviderId;
|
|
91
|
-
readonly url: string;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* `attach` input — subscribe a reference to a plan. A thin, plan-oriented skin over
|
|
95
|
-
* {@link CheckoutInput}: `mode` defaults to `"subscription"` (the common case), so callers pass
|
|
96
|
-
* just `{ referenceId, priceId, successUrl, cancelUrl }`.
|
|
97
|
-
*/
|
|
98
|
-
interface AttachInput extends Omit<CheckoutInput, "mode"> {
|
|
99
|
-
readonly mode?: CheckoutInput["mode"];
|
|
100
|
-
}
|
|
101
|
-
interface PortalInput {
|
|
102
|
-
readonly customerId: string;
|
|
103
|
-
readonly returnUrl: string;
|
|
104
|
-
}
|
|
105
|
-
/** A single durable usage record — one metered event for a `(referenceId, featureId)` pair. */
|
|
106
|
-
interface UsageEvent {
|
|
107
|
-
readonly createdAt: number;
|
|
108
|
-
readonly featureId: string;
|
|
109
|
-
/** Caller-stable dedupe key — recording the same key twice is a no-op (exactly-once `track`). */
|
|
110
|
-
readonly idempotencyKey: string;
|
|
111
|
-
readonly provider: ProviderId;
|
|
112
|
-
readonly quantity: number;
|
|
113
|
-
readonly referenceId: string;
|
|
114
|
-
/** Whether the event was successfully forwarded to the provider's metering API. */
|
|
115
|
-
readonly reportedToProvider: boolean;
|
|
116
|
-
}
|
|
117
|
-
/** `track` input — record metered usage for a reference's feature. */
|
|
118
|
-
interface TrackInput {
|
|
119
|
-
readonly featureId: string;
|
|
120
|
-
/** Caller-supplied dedupe key; a fresh one is generated when omitted (so each call records). */
|
|
121
|
-
readonly idempotencyKey?: string;
|
|
122
|
-
/** `"add"` (default) increments usage by `quantity`; `"set"` reconciles the period total to `quantity`. */
|
|
123
|
-
readonly mode?: "add" | "set";
|
|
124
|
-
/** Usage amount to add, or the absolute period total when `mode` is `"set"` (defaults to `1`). */
|
|
125
|
-
readonly quantity?: number;
|
|
126
|
-
readonly referenceId: string;
|
|
127
|
-
}
|
|
128
|
-
/** Result of a `track` call. */
|
|
129
|
-
interface TrackResult {
|
|
130
|
-
/** True when this call inserted a new usage event; false when deduplicated by idempotency key. */
|
|
131
|
-
readonly recorded: boolean;
|
|
132
|
-
/** True when the event was forwarded to the provider's metering API. */
|
|
133
|
-
readonly reportedToProvider: boolean;
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* `check` input — is a reference allowed something right now? Pass `featureId` to check a feature
|
|
137
|
-
* grant/allowance, or `priceId` to check active access to a product (one of the two is required).
|
|
138
|
-
*/
|
|
139
|
-
interface CheckInput {
|
|
140
|
-
/** Feature to check a grant/allowance for. Provide this **or** `priceId`. */
|
|
141
|
-
readonly featureId?: string;
|
|
142
|
-
/** Provider price/product id to check active access for. Provide this **or** `featureId`. */
|
|
143
|
-
readonly priceId?: string;
|
|
144
|
-
/** Units the caller intends to consume; the check passes only when this many remain (default `1`). */
|
|
145
|
-
readonly quantity?: number;
|
|
146
|
-
readonly referenceId: string;
|
|
147
|
-
}
|
|
148
|
-
/** Result of a `check` call. */
|
|
149
|
-
interface CheckResult {
|
|
150
|
-
/** Whether the reference may consume `quantity` units of the feature right now. */
|
|
151
|
-
readonly allowed: boolean;
|
|
152
|
-
/** Remaining units this period (`limit - used`), for metered features only. */
|
|
153
|
-
readonly balance?: number;
|
|
154
|
-
/** The plan-granted cap, for metered features only. */
|
|
155
|
-
readonly limit?: number;
|
|
156
|
-
/** True for a boolean feature granted without a numeric cap. */
|
|
157
|
-
readonly unlimited: boolean;
|
|
158
|
-
/** Usage consumed this period, for metered features only. */
|
|
159
|
-
readonly used?: number;
|
|
160
|
-
}
|
|
161
|
-
/** One feature's resolved allowance for a reference — a {@link CheckResult} tagged with its feature. */
|
|
162
|
-
interface FeatureBalance extends CheckResult {
|
|
163
|
-
readonly featureId: string;
|
|
164
|
-
}
|
|
165
|
-
/** Input the adapter forwards to the provider's metering API (Stripe Meter Events / Polar ingestion). */
|
|
166
|
-
interface ReportUsageInput {
|
|
167
|
-
/** Provider customer id, when known (Stripe meter events key on it). */
|
|
168
|
-
readonly customerId?: string;
|
|
169
|
-
readonly featureId: string;
|
|
170
|
-
readonly idempotencyKey: string;
|
|
171
|
-
readonly quantity: number;
|
|
172
|
-
readonly referenceId: string;
|
|
173
|
-
/** Event time in epoch ms; defaults to now at the provider. */
|
|
174
|
-
readonly timestamp?: number;
|
|
175
|
-
}
|
|
176
|
-
interface CaptureInput {
|
|
177
|
-
/** Partial capture amount; full capture when omitted. */
|
|
178
|
-
readonly amount?: Money;
|
|
179
|
-
readonly idempotencyKey?: string;
|
|
180
|
-
readonly sessionId: string;
|
|
181
|
-
}
|
|
182
|
-
interface RefundInput {
|
|
183
|
-
/** Partial refund amount; full refund when omitted. */
|
|
184
|
-
readonly amount?: Money;
|
|
185
|
-
readonly idempotencyKey?: string;
|
|
186
|
-
readonly reason?: string;
|
|
187
|
-
readonly sessionId: string;
|
|
188
|
-
}
|
|
189
|
-
interface CancelSubscriptionOptions {
|
|
190
|
-
/** Cancel at period end instead of immediately. */
|
|
191
|
-
readonly atPeriodEnd?: boolean;
|
|
192
|
-
readonly idempotencyKey?: string;
|
|
193
|
-
}
|
|
194
|
-
interface SubscriptionPatch {
|
|
195
|
-
readonly priceId?: string;
|
|
196
|
-
readonly quantity?: number;
|
|
197
|
-
}
|
|
198
|
-
/** Normalized webhook outcome — the *core state transition* a provider event implies. */
|
|
199
|
-
type WebhookActionType = "payment.authorized" | "payment.captured" | "payment.failed" | "payment.refunded" | "subscription.active" | "subscription.canceled" | "subscription.past_due" | "subscription.paused" | "subscription.updated" | "unhandled";
|
|
200
|
-
/**
|
|
201
|
-
* How a refund action's {@link WebhookAction.amount} should be interpreted by the sync layer.
|
|
202
|
-
*
|
|
203
|
-
* `"delta"` is an incremental amount added to the running refunded total (Polar `refund.created`,
|
|
204
|
-
* and the historical default), so multiple events accumulate. `"absolute"` is the provider's
|
|
205
|
-
* cumulative refunded-to-date total (Stripe `charge.refunded` carries `amount_refunded`, which
|
|
206
|
-
* already sums all prior partial refunds); the sync layer sets the refunded total to this value
|
|
207
|
-
* rather than adding, so repeated partial-refund events do not over-count.
|
|
208
|
-
*
|
|
209
|
-
* Omitted means `"delta"`, preserving the original behavior for callers that predate this field.
|
|
210
|
-
*/
|
|
211
|
-
type RefundAmountKind = "absolute" | "delta";
|
|
212
|
-
interface WebhookAction {
|
|
213
|
-
readonly amount?: Money;
|
|
214
|
-
/**
|
|
215
|
-
* Interpretation of {@link WebhookAction.amount} for refund actions (`payment.refunded`).
|
|
216
|
-
* Defaults to `"delta"` when omitted. Ignored for non-refund actions.
|
|
217
|
-
*/
|
|
218
|
-
readonly amountKind?: RefundAmountKind;
|
|
219
|
-
readonly cancelAtPeriodEnd?: boolean;
|
|
220
|
-
readonly currentPeriodEnd?: number;
|
|
221
|
-
readonly currentPeriodStart?: number;
|
|
222
|
-
readonly customerId?: string;
|
|
223
|
-
/** Provider event id — the inbound idempotency key. */
|
|
224
|
-
readonly eventId: string;
|
|
225
|
-
readonly priceId?: string;
|
|
226
|
-
readonly provider: ProviderId;
|
|
227
|
-
readonly quantity?: number;
|
|
228
|
-
/** Raw provider event, retained for the events log / debugging. */
|
|
229
|
-
readonly raw?: unknown;
|
|
230
|
-
readonly referenceId?: string;
|
|
231
|
-
readonly sessionId?: string;
|
|
232
|
-
readonly subscriptionId?: string;
|
|
233
|
-
readonly type: WebhookActionType;
|
|
234
|
-
}
|
|
235
|
-
/** Result of applying a webhook action to the store. */
|
|
236
|
-
interface ApplyResult {
|
|
237
|
-
readonly applied: boolean;
|
|
238
|
-
readonly reason?: "duplicate" | "illegal_transition" | "invalid_refund_amount" | "ok" | "unhandled";
|
|
239
|
-
}
|
|
240
|
-
/** A read-only header bag; the platform `Headers` object satisfies it. */
|
|
241
|
-
interface WebhookHeaders {
|
|
242
|
-
get: (name: string) => null | string;
|
|
243
|
-
}
|
|
244
|
-
interface WebhookInput {
|
|
245
|
-
/** Request headers (signature schemes read provider-specific headers from here). */
|
|
246
|
-
readonly headers: WebhookHeaders;
|
|
247
|
-
/** Raw request body, exactly as received (required for signature verification). */
|
|
248
|
-
readonly payload: string;
|
|
249
|
-
}
|
|
250
|
-
/**
|
|
251
|
-
* A stateless translator between the provider API and Lunora's normalized vocabulary.
|
|
252
|
-
*
|
|
253
|
-
* Adapters never own state — they make provider calls and normalize provider events into a
|
|
254
|
-
* `WebhookAction`. All durable state lives in the payment store.
|
|
255
|
-
*/
|
|
256
|
-
interface PaymentAdapter {
|
|
257
|
-
cancelPayment: (sessionId: string, options?: {
|
|
258
|
-
idempotencyKey?: string;
|
|
259
|
-
}) => Promise<PaymentSession>;
|
|
260
|
-
cancelSubscription: (subscriptionId: string, options?: CancelSubscriptionOptions) => Promise<Subscription>;
|
|
261
|
-
readonly capabilities: ProviderCapabilities;
|
|
262
|
-
capturePayment: (input: CaptureInput) => Promise<PaymentSession>;
|
|
263
|
-
createCheckout: (input: CheckoutInput) => Promise<CheckoutResult>;
|
|
264
|
-
createPortalSession: (input: PortalInput) => Promise<{
|
|
265
|
-
url: string;
|
|
266
|
-
}>;
|
|
267
|
-
getOrCreateCustomer: (ref: CustomerRef) => Promise<Customer>;
|
|
268
|
-
/** Fetch the provider's current truth for a payment session — the basis for reconciliation. */
|
|
269
|
-
getPaymentStatus: (sessionId: string) => Promise<PaymentSession>;
|
|
270
|
-
/** Fetch the provider's current truth for a subscription — the basis for reconciliation. */
|
|
271
|
-
getSubscriptionStatus: (subscriptionId: string) => Promise<Subscription>;
|
|
272
|
-
/** Stable provider identifier (Medusa-style). */
|
|
273
|
-
readonly identifier: ProviderId;
|
|
274
|
-
/** Verify the signature over the raw body, then normalize the event. Throws on invalid signature. */
|
|
275
|
-
parseWebhook: (input: WebhookInput) => Promise<WebhookAction>;
|
|
276
|
-
refundPayment: (input: RefundInput) => Promise<PaymentSession>;
|
|
277
|
-
/**
|
|
278
|
-
* Forward metered usage to the provider's billing API. Optional — present only on providers
|
|
279
|
-
* whose `capabilities.usageMetering` is `true` and that expose an ingestion endpoint. When
|
|
280
|
-
* absent, `track` still records usage durably and `check` enforces limits locally.
|
|
281
|
-
*/
|
|
282
|
-
reportUsage?: (input: ReportUsageInput) => Promise<void>;
|
|
283
|
-
resumeSubscription: (subscriptionId: string) => Promise<Subscription>;
|
|
284
|
-
updateSubscription: (subscriptionId: string, patch: SubscriptionPatch) => Promise<Subscription>;
|
|
285
|
-
}
|
|
286
|
-
/** Registry of adapters keyed by provider id — supports dual-register during provider migration. */
|
|
287
|
-
interface AdapterRegistry {
|
|
288
|
-
all: () => PaymentAdapter[];
|
|
289
|
-
get: (provider: ProviderId) => PaymentAdapter;
|
|
290
|
-
has: (provider: ProviderId) => boolean;
|
|
291
|
-
}
|
|
292
|
-
declare const createAdapterRegistry: (adapters: ReadonlyArray<PaymentAdapter>) => AdapterRegistry;
|
|
6
|
+
* `PaymentStore` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
7
|
+
* @experimental
|
|
8
|
+
*/
|
|
293
9
|
interface PaymentStore {
|
|
294
10
|
getCustomerByReference: (provider: ProviderId, referenceId: string) => Promise<Customer | undefined>;
|
|
295
11
|
getPaymentSession: (provider: ProviderId, id: string) => Promise<PaymentSession | undefined>;
|
|
296
12
|
getSubscription: (provider: ProviderId, id: string) => Promise<Subscription | undefined>;
|
|
297
13
|
listSubscriptionsByReference: (referenceId: string) => Promise<Subscription[]>;
|
|
298
14
|
/**
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
15
|
+
* Claims a provider event id for processing. Resolves `true` the first time an event is seen
|
|
16
|
+
* and `false` for a duplicate — the inbound-idempotency primitive.
|
|
17
|
+
*/
|
|
302
18
|
markEventProcessed: (provider: ProviderId, eventId: string) => Promise<boolean>;
|
|
303
19
|
/** Flag a recorded usage event as forwarded to the provider's metering API. */
|
|
304
20
|
markUsageReported: (provider: ProviderId, idempotencyKey: string) => Promise<void>;
|
|
305
21
|
/**
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
22
|
+
* Append a usage event. Resolves `true` when newly recorded and `false` when its
|
|
23
|
+
* `idempotencyKey` was already seen — the exactly-once primitive behind `track`.
|
|
24
|
+
*/
|
|
309
25
|
recordUsage: (event: UsageEvent) => Promise<boolean>;
|
|
310
26
|
/**
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
27
|
+
* Release a previously-claimed event id (see {@link PaymentStore.markEventProcessed}) so a
|
|
28
|
+
* provider retry can re-process it. Called only when applying the claimed event *throws* (a
|
|
29
|
+
* genuine store-write failure): the atomic insert-claim guards concurrent duplicates, but a
|
|
30
|
+
* claim that outlives a failed apply would dedupe the retry and lose the effect — so the claim
|
|
31
|
+
* is rolled back on failure. A no-op if the id was never claimed.
|
|
32
|
+
*/
|
|
317
33
|
releaseEvent: (provider: ProviderId, eventId: string) => Promise<void>;
|
|
318
|
-
/**
|
|
34
|
+
/**
|
|
35
|
+
* The period total for a `(referenceId, featureId)` pair since `since` (epoch ms).
|
|
36
|
+
*
|
|
37
|
+
* NOT a plain sum: events are folded in `createdAt` order (ties broken by
|
|
38
|
+
* `idempotencyKey`, so every store agrees on the same order for events stamped
|
|
39
|
+
* in the same millisecond). An `"add"` event increments the running total; a
|
|
40
|
+
* `"set"` event RESETS it to that event's `quantity`, discarding everything
|
|
41
|
+
* earlier in the period. Use {@link foldUsage} so the two implementations
|
|
42
|
+
* cannot drift.
|
|
43
|
+
*
|
|
44
|
+
* This fold is what lets `track({ mode: "set" })` be append-only. Reconciling by
|
|
45
|
+
* writing `target - current` instead would be a read-modify-write across two
|
|
46
|
+
* un-transacted store calls: two interleaved `set`s would both read the same
|
|
47
|
+
* total, both append a delta, and leave the period over- or under-counted —
|
|
48
|
+
* inflating `balance = limit - used`. Here a concurrent pair simply resolves
|
|
49
|
+
* last-writer-wins, and a replayed `set` is idempotent by construction.
|
|
50
|
+
*/
|
|
319
51
|
sumUsage: (referenceId: string, featureId: string, since: number) => Promise<number>;
|
|
52
|
+
/** Period usage totals for many features in one read — the batch form of {@link PaymentStore.sumUsage}. */
|
|
53
|
+
sumUsageByFeature: (referenceId: string, featureIds: ReadonlyArray<string>, since: number) => Promise<ReadonlyMap<string, number>>;
|
|
320
54
|
upsertCustomer: (customer: Customer) => Promise<void>;
|
|
321
55
|
upsertPaymentSession: (session: PaymentSession) => Promise<void>;
|
|
322
56
|
upsertSubscription: (subscription: Subscription) => Promise<void>;
|
|
323
57
|
}
|
|
324
|
-
/**
|
|
58
|
+
/**
|
|
59
|
+
* In-memory {@link PaymentStore} for tests and local development. Not durable.
|
|
60
|
+
* @experimental
|
|
61
|
+
*/
|
|
325
62
|
declare class MemoryPaymentStore implements PaymentStore {
|
|
326
63
|
private readonly customers;
|
|
327
64
|
private readonly processedEvents;
|
|
@@ -337,10 +74,15 @@ declare class MemoryPaymentStore implements PaymentStore {
|
|
|
337
74
|
markUsageReported(provider: ProviderId, idempotencyKey: string): Promise<void>;
|
|
338
75
|
recordUsage(event: UsageEvent): Promise<boolean>;
|
|
339
76
|
sumUsage(referenceId: string, featureId: string, since: number): Promise<number>;
|
|
77
|
+
sumUsageByFeature(referenceId: string, featureIds: ReadonlyArray<string>, since: number): Promise<ReadonlyMap<string, number>>;
|
|
340
78
|
upsertCustomer(customer: Customer): Promise<void>;
|
|
341
79
|
upsertPaymentSession(session: PaymentSession): Promise<void>;
|
|
342
80
|
upsertSubscription(subscription: Subscription): Promise<void>;
|
|
343
81
|
}
|
|
82
|
+
/**
|
|
83
|
+
* `PlanDefinition` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
84
|
+
* @experimental
|
|
85
|
+
*/
|
|
344
86
|
interface PlanDefinition {
|
|
345
87
|
/** Feature flags this plan grants. */
|
|
346
88
|
readonly features?: ReadonlyArray<string>;
|
|
@@ -349,10 +91,18 @@ interface PlanDefinition {
|
|
|
349
91
|
/** Provider price/product ids that grant this plan. */
|
|
350
92
|
readonly priceIds: ReadonlyArray<string>;
|
|
351
93
|
}
|
|
94
|
+
/**
|
|
95
|
+
* `EntitlementsConfig` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
96
|
+
* @experimental
|
|
97
|
+
*/
|
|
352
98
|
interface EntitlementsConfig {
|
|
353
99
|
/** Plan name → definition. */
|
|
354
100
|
readonly plans: Record<string, PlanDefinition>;
|
|
355
101
|
}
|
|
102
|
+
/**
|
|
103
|
+
* `Entitlements` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
104
|
+
* @experimental
|
|
105
|
+
*/
|
|
356
106
|
interface Entitlements {
|
|
357
107
|
readonly features: ReadonlySet<string>;
|
|
358
108
|
/** True when an active subscription grants `feature`. */
|
|
@@ -363,19 +113,36 @@ interface Entitlements {
|
|
|
363
113
|
readonly plans: ReadonlyArray<string>;
|
|
364
114
|
}
|
|
365
115
|
/**
|
|
366
|
-
* Start of the window `check` sums metered usage over: the most recent billing-period start among
|
|
367
|
-
* a reference's active subscriptions. `0` (count all-time) when no active subscription reports one
|
|
368
|
-
* — limits still bind, they just never reset until the provider sends a period.
|
|
369
|
-
|
|
116
|
+
* Start of the window `check` sums metered usage over: the most recent billing-period start among
|
|
117
|
+
* a reference's active subscriptions. `0` (count all-time) when no active subscription reports one
|
|
118
|
+
* — limits still bind, they just never reset until the provider sends a period.
|
|
119
|
+
* @experimental
|
|
120
|
+
*/
|
|
370
121
|
declare const usagePeriodStart: (subscriptions: ReadonlyArray<Subscription>) => number;
|
|
371
|
-
/**
|
|
122
|
+
/**
|
|
123
|
+
* Every feature name a config can grant — the union of `features` flags and `limits` keys across all plans, sorted.
|
|
124
|
+
* @experimental
|
|
125
|
+
*/
|
|
372
126
|
declare const featureNames: (config: EntitlementsConfig) => string[];
|
|
373
|
-
/**
|
|
127
|
+
/**
|
|
128
|
+
* Whether the reference holds an entitling (active/trialing) subscription on `priceId` — the basis of a product `check`.
|
|
129
|
+
* @experimental
|
|
130
|
+
*/
|
|
374
131
|
declare const hasActivePrice: (subscriptions: ReadonlyArray<Subscription>, priceId: string) => boolean;
|
|
375
|
-
/**
|
|
132
|
+
/**
|
|
133
|
+
* Derive {@link Entitlements} from a reference's subscriptions. Pure — the basis of `check`.
|
|
134
|
+
* @experimental
|
|
135
|
+
*/
|
|
376
136
|
declare const resolveEntitlements: (config: EntitlementsConfig, subscriptions: ReadonlyArray<Subscription>) => Entitlements;
|
|
377
|
-
/**
|
|
137
|
+
/**
|
|
138
|
+
* Convenience: resolve entitlements straight from the store for a reference.
|
|
139
|
+
* @experimental
|
|
140
|
+
*/
|
|
378
141
|
declare const entitlementsForReference: (store: PaymentStore, config: EntitlementsConfig, referenceId: string) => Promise<Entitlements>;
|
|
142
|
+
/**
|
|
143
|
+
* `PaymentEvent` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
144
|
+
* @experimental
|
|
145
|
+
*/
|
|
379
146
|
type PaymentEvent = {
|
|
380
147
|
action: WebhookActionType;
|
|
381
148
|
eventId: string;
|
|
@@ -420,15 +187,26 @@ type PaymentEvent = {
|
|
|
420
187
|
referenceId: string;
|
|
421
188
|
type: "usage.report_failed";
|
|
422
189
|
};
|
|
190
|
+
/**
|
|
191
|
+
* `PaymentObserver` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
192
|
+
* @experimental
|
|
193
|
+
*/
|
|
423
194
|
type PaymentObserver = (event: PaymentEvent) => void;
|
|
424
|
-
/**
|
|
195
|
+
/**
|
|
196
|
+
* Returns whether the current caller may act on `referenceId`. Throwing is also treated as denial.
|
|
197
|
+
* @experimental
|
|
198
|
+
*/
|
|
425
199
|
type AuthorizeReference = (referenceId: string) => boolean | Promise<boolean>;
|
|
200
|
+
/**
|
|
201
|
+
* `CreatePaymentOptions` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
202
|
+
* @experimental
|
|
203
|
+
*/
|
|
426
204
|
interface CreatePaymentOptions {
|
|
427
205
|
readonly adapter: PaymentAdapter;
|
|
428
206
|
/**
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
207
|
+
* Per-caller authorization for every mutation. Return `false` to reject with 403. Omit only
|
|
208
|
+
* for trusted server-internal callers (e.g. the reconciliation sweep).
|
|
209
|
+
*/
|
|
432
210
|
readonly authorize?: AuthorizeReference;
|
|
433
211
|
/** Plan → features/limits map. Required for `check`; omit if you don't gate features. */
|
|
434
212
|
readonly entitlements?: EntitlementsConfig;
|
|
@@ -436,44 +214,69 @@ interface CreatePaymentOptions {
|
|
|
436
214
|
readonly observability?: PaymentObserver;
|
|
437
215
|
readonly store: PaymentStore;
|
|
438
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* `LunoraPayment` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
219
|
+
* @experimental
|
|
220
|
+
*/
|
|
439
221
|
interface LunoraPayment {
|
|
440
222
|
readonly adapter: PaymentAdapter;
|
|
441
223
|
/**
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
224
|
+
* Subscribe a reference to a plan — a plan-oriented alias of {@link LunoraPayment.createCheckout}
|
|
225
|
+
* with `mode` defaulting to `"subscription"`. Returns a hosted-checkout URL to redirect to.
|
|
226
|
+
*/
|
|
445
227
|
attach: (input: AttachInput) => Promise<CheckoutResult>;
|
|
228
|
+
/** Cancel the caller's own uncaptured payment (authorized, derived idempotency key, store synced). */
|
|
229
|
+
cancelPayment: (sessionId: string, options?: {
|
|
230
|
+
idempotencyKey?: string;
|
|
231
|
+
}) => Promise<PaymentSession>;
|
|
446
232
|
cancelSubscription: (subscriptionId: string, options?: CancelSubscriptionOptions) => Promise<Subscription>;
|
|
233
|
+
/** Capture the caller's own authorized payment (authorized, derived idempotency key, store synced). */
|
|
234
|
+
capturePayment: (input: CaptureInput) => Promise<PaymentSession>;
|
|
447
235
|
/**
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
236
|
+
* Is a reference allowed something right now? Pass `featureId` to check a grant/allowance (boolean
|
|
237
|
+
* features check plan grants; metered features subtract usage tracked this period) or `priceId` to
|
|
238
|
+
* check active access to a product. The feature path requires `entitlements` to be configured.
|
|
239
|
+
*/
|
|
452
240
|
check: (input: CheckInput) => Promise<CheckResult>;
|
|
453
241
|
createCheckout: (input: CheckoutInput) => Promise<CheckoutResult>;
|
|
454
242
|
/** Open the provider billing portal for the caller's own customer (derived from the store). */
|
|
455
243
|
createPortalSession: (referenceId: string, returnUrl: string) => Promise<{
|
|
456
244
|
url: string;
|
|
457
245
|
}>;
|
|
458
|
-
/**
|
|
246
|
+
/**
|
|
247
|
+
* Verify + normalize + apply a provider webhook. 200 once verified, even on a no-op — except an
|
|
248
|
+
* event whose target row doesn't exist yet, which returns 500 so the provider redelivers it once.
|
|
249
|
+
*/
|
|
459
250
|
handleWebhook: (request: Request) => Promise<Response>;
|
|
460
251
|
/** Resolve every configured feature's allowance for a reference in one call. Requires `entitlements`. */
|
|
461
252
|
listBalances: (referenceId: string) => Promise<FeatureBalance[]>;
|
|
462
253
|
listSubscriptions: (referenceId: string) => Promise<Subscription[]>;
|
|
254
|
+
/** Refund the caller's own captured payment (authorized, derived idempotency key, store synced). */
|
|
255
|
+
refundPayment: (input: RefundInput) => Promise<PaymentSession>;
|
|
463
256
|
readonly store: PaymentStore;
|
|
464
257
|
/**
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
258
|
+
* Record metered usage for a reference's feature — durably (exactly-once by idempotency key) and,
|
|
259
|
+
* when the provider supports it, forwarded to its metering API. Best-effort upstream: a reporting
|
|
260
|
+
* failure is observed, never thrown, and the local ledger that `check` reads is always updated.
|
|
261
|
+
*/
|
|
469
262
|
track: (input: TrackInput) => Promise<TrackResult>;
|
|
470
263
|
}
|
|
264
|
+
/**
|
|
265
|
+
* `createPayment` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
266
|
+
* @experimental
|
|
267
|
+
*/
|
|
471
268
|
declare const createPayment: (options: CreatePaymentOptions) => LunoraPayment;
|
|
472
|
-
/**
|
|
269
|
+
/**
|
|
270
|
+
* A stored row, carrying Lunora's document id.
|
|
271
|
+
* @experimental
|
|
272
|
+
*/
|
|
473
273
|
interface PaymentRow extends Record<string, unknown> {
|
|
474
274
|
readonly _id: string;
|
|
475
275
|
}
|
|
476
|
-
/**
|
|
276
|
+
/**
|
|
277
|
+
* Minimal write/read surface this store needs; `ctx.db` satisfies it structurally.
|
|
278
|
+
* @experimental
|
|
279
|
+
*/
|
|
477
280
|
interface PaymentDatabase {
|
|
478
281
|
delete: (id: string) => Promise<void>;
|
|
479
282
|
findFirst: (table: string, where: Record<string, unknown>) => Promise<PaymentRow | null>;
|
|
@@ -481,8 +284,15 @@ interface PaymentDatabase {
|
|
|
481
284
|
insert: (table: string, document: Record<string, unknown>) => Promise<string>;
|
|
482
285
|
patch: (id: string, patch: Record<string, unknown>) => Promise<void>;
|
|
483
286
|
}
|
|
287
|
+
/**
|
|
288
|
+
* `createDatabasePaymentStore` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
289
|
+
* @experimental
|
|
290
|
+
*/
|
|
484
291
|
declare const createDatabasePaymentStore: (database: PaymentDatabase) => PaymentStore;
|
|
485
|
-
/**
|
|
292
|
+
/**
|
|
293
|
+
* Structural subset of Lunora's `ctx.db` (the `findFirst`/`findMany(tableName, { where })` form).
|
|
294
|
+
* @experimental
|
|
295
|
+
*/
|
|
486
296
|
interface LunoraDatabaseLike {
|
|
487
297
|
delete: (id: string) => Promise<void>;
|
|
488
298
|
findFirst: (table: string, args?: {
|
|
@@ -496,13 +306,20 @@ interface LunoraDatabaseLike {
|
|
|
496
306
|
insert: (table: string, document: Record<string, unknown>) => Promise<string>;
|
|
497
307
|
patch: (id: string, patch: Record<string, unknown>) => Promise<void>;
|
|
498
308
|
}
|
|
499
|
-
/**
|
|
309
|
+
/**
|
|
310
|
+
* Structural subset of a Lunora function context used to build payments.
|
|
311
|
+
* @experimental
|
|
312
|
+
*/
|
|
500
313
|
interface PaymentContextLike {
|
|
501
314
|
auth?: {
|
|
502
315
|
userId?: null | string;
|
|
503
316
|
};
|
|
504
317
|
db: LunoraDatabaseLike;
|
|
505
318
|
}
|
|
319
|
+
/**
|
|
320
|
+
* `PaymentsFromContextOptions` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
321
|
+
* @experimental
|
|
322
|
+
*/
|
|
506
323
|
interface PaymentsFromContextOptions {
|
|
507
324
|
readonly adapter: PaymentAdapter;
|
|
508
325
|
/** Override the default "caller owns the referenceId" authorization. */
|
|
@@ -512,190 +329,102 @@ interface PaymentsFromContextOptions {
|
|
|
512
329
|
/** Optional telemetry sink, forwarded to the facade. */
|
|
513
330
|
readonly observability?: PaymentObserver;
|
|
514
331
|
}
|
|
515
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Adapt a Lunora `ctx.db` to the {@link PaymentDatabase} port the store writes through.
|
|
334
|
+
* @experimental
|
|
335
|
+
*/
|
|
516
336
|
declare const lunoraDatabaseToPaymentDatabase: (database: LunoraDatabaseLike) => PaymentDatabase;
|
|
337
|
+
/**
|
|
338
|
+
* `paymentsFromContext` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
339
|
+
* @experimental
|
|
340
|
+
*/
|
|
517
341
|
declare const paymentsFromContext: (context: PaymentContextLike, options: PaymentsFromContextOptions) => LunoraPayment;
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
342
|
+
/**
|
|
343
|
+
* `PaymentErrorCode` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
344
|
+
* @experimental
|
|
345
|
+
*/
|
|
346
|
+
type PaymentErrorCode = "CONFIG_INVALID" | "CURRENCY_MISMATCH" | "FORBIDDEN" | "INVALID_TRANSITION" | "NOT_FOUND" | "PROVIDER_ERROR" | "VALIDATION_ERROR" | "WEBHOOK_EVENT_ID_MISSING" | "WEBHOOK_SIGNATURE_INVALID" | "WEBHOOK_TIMESTAMP_INVALID";
|
|
347
|
+
/**
|
|
348
|
+
* Typed error for all `@lunora/payment` failures. A `LunoraError` subclass; `status` maps onto an HTTP response.
|
|
349
|
+
* @experimental
|
|
350
|
+
*/
|
|
351
|
+
declare class LunoraPaymentError extends LunoraError {
|
|
521
352
|
readonly code: PaymentErrorCode;
|
|
522
|
-
readonly status: number;
|
|
523
353
|
constructor(code: PaymentErrorCode, message: string);
|
|
524
354
|
}
|
|
525
355
|
/**
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
|
|
529
|
-
* a Worker retry can never double-charge. Distinct from inbound webhook dedupe (keyed on the
|
|
530
|
-
* provider event id).
|
|
531
|
-
*/
|
|
532
|
-
/** Build a deterministic idempotency key from an operation name and stable parts. */
|
|
356
|
+
* Build a deterministic idempotency key from an operation name and stable parts.
|
|
357
|
+
* @experimental
|
|
358
|
+
*/
|
|
533
359
|
declare const idempotencyKey: (operation: string, ...parts: ReadonlyArray<number | string>) => string;
|
|
534
|
-
/**
|
|
360
|
+
/**
|
|
361
|
+
* True when the currency has no minor unit (e.g. JPY).
|
|
362
|
+
* @experimental
|
|
363
|
+
*/
|
|
535
364
|
declare const isZeroDecimalCurrency: (currency: CurrencyCode) => boolean;
|
|
536
|
-
/**
|
|
365
|
+
/**
|
|
366
|
+
* Construct money. Currency is normalized to uppercase; never use floats for amounts.
|
|
367
|
+
* @experimental
|
|
368
|
+
*/
|
|
537
369
|
declare const money: (minorUnits: bigint | number, currency: CurrencyCode) => Money;
|
|
370
|
+
/**
|
|
371
|
+
* `zeroMoney` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
372
|
+
* @experimental
|
|
373
|
+
*/
|
|
538
374
|
declare const zeroMoney: (currency: CurrencyCode) => Money;
|
|
539
|
-
/**
|
|
375
|
+
/**
|
|
376
|
+
* Localized currency string for display (e.g. `$19.99`). For UI only — never for arithmetic.
|
|
377
|
+
* @experimental
|
|
378
|
+
*/
|
|
540
379
|
declare const formatMoney: (value: Money, locale?: string) => string;
|
|
380
|
+
/**
|
|
381
|
+
* `addMoney` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
382
|
+
* @experimental
|
|
383
|
+
*/
|
|
541
384
|
declare const addMoney: (a: Money, b: Money) => Money;
|
|
385
|
+
/**
|
|
386
|
+
* `subtractMoney` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
387
|
+
* @experimental
|
|
388
|
+
*/
|
|
542
389
|
declare const subtractMoney: (a: Money, b: Money) => Money;
|
|
543
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* Compares two same-currency amounts, returning -1, 0, or 1.
|
|
392
|
+
* @experimental
|
|
393
|
+
*/
|
|
544
394
|
declare const compareMoney: (a: Money, b: Money) => -1 | 0 | 1;
|
|
545
395
|
/**
|
|
546
|
-
* Split an amount across integer ratios, distributing the remainder to the smallest unit so the
|
|
547
|
-
* parts always sum back to the original. The basis for seat/proration math.
|
|
548
|
-
|
|
396
|
+
* Split an amount across integer ratios, distributing the remainder to the smallest unit so the
|
|
397
|
+
* parts always sum back to the original. The basis for seat/proration math.
|
|
398
|
+
* @experimental
|
|
399
|
+
*/
|
|
549
400
|
declare const allocateMoney: (amount: Money, ratios: ReadonlyArray<bigint>) => Money[];
|
|
401
|
+
/**
|
|
402
|
+
* `isZeroMoney` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
403
|
+
* @experimental
|
|
404
|
+
*/
|
|
550
405
|
declare const isZeroMoney: (a: Money) => boolean;
|
|
551
|
-
/**
|
|
406
|
+
/**
|
|
407
|
+
* JSON-safe wire form of money (bigint encoded as a decimal string).
|
|
408
|
+
* @experimental
|
|
409
|
+
*/
|
|
552
410
|
interface MoneyJSON {
|
|
553
411
|
readonly currency: CurrencyCode;
|
|
554
412
|
readonly minorUnits: string;
|
|
555
413
|
}
|
|
414
|
+
/**
|
|
415
|
+
* `toMoneyJSON` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
416
|
+
* @experimental
|
|
417
|
+
*/
|
|
556
418
|
declare const toMoneyJSON: (m: Money) => MoneyJSON;
|
|
419
|
+
/**
|
|
420
|
+
* `fromMoneyJSON` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
421
|
+
* @experimental
|
|
422
|
+
*/
|
|
557
423
|
declare const fromMoneyJSON: (json: MoneyJSON) => Money;
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
readonly customerId?: null | string;
|
|
563
|
-
readonly id: string;
|
|
564
|
-
readonly metadata?: Record<string, string>;
|
|
565
|
-
readonly productId?: string;
|
|
566
|
-
readonly status: string;
|
|
567
|
-
}
|
|
568
|
-
interface PolarOrderLike {
|
|
569
|
-
readonly amount?: number;
|
|
570
|
-
readonly currency?: string;
|
|
571
|
-
readonly id: string;
|
|
572
|
-
readonly status: string;
|
|
573
|
-
readonly totalAmount?: number;
|
|
574
|
-
}
|
|
575
|
-
interface PolarClientLike {
|
|
576
|
-
readonly checkouts: {
|
|
577
|
-
create: (parameters: Record<string, unknown>) => Promise<{
|
|
578
|
-
id: string;
|
|
579
|
-
url: string;
|
|
580
|
-
}>;
|
|
581
|
-
};
|
|
582
|
-
readonly customers: {
|
|
583
|
-
create: (parameters: Record<string, unknown>) => Promise<{
|
|
584
|
-
email: null | string;
|
|
585
|
-
id: string;
|
|
586
|
-
}>;
|
|
587
|
-
};
|
|
588
|
-
readonly customerSessions: {
|
|
589
|
-
create: (parameters: Record<string, unknown>) => Promise<{
|
|
590
|
-
customerPortalUrl: string;
|
|
591
|
-
}>;
|
|
592
|
-
};
|
|
593
|
-
readonly events: {
|
|
594
|
-
ingest: (parameters: Record<string, unknown>) => Promise<{
|
|
595
|
-
inserted?: number;
|
|
596
|
-
}>;
|
|
597
|
-
};
|
|
598
|
-
readonly orders: {
|
|
599
|
-
get: (parameters: Record<string, unknown>) => Promise<PolarOrderLike>;
|
|
600
|
-
};
|
|
601
|
-
readonly refunds: {
|
|
602
|
-
create: (parameters: Record<string, unknown>) => Promise<{
|
|
603
|
-
id: string;
|
|
604
|
-
}>;
|
|
605
|
-
};
|
|
606
|
-
readonly subscriptions: {
|
|
607
|
-
get: (parameters: Record<string, unknown>) => Promise<PolarSubscriptionLike>;
|
|
608
|
-
revoke: (parameters: Record<string, unknown>) => Promise<PolarSubscriptionLike>;
|
|
609
|
-
update: (parameters: Record<string, unknown>) => Promise<PolarSubscriptionLike>;
|
|
610
|
-
};
|
|
611
|
-
}
|
|
612
|
-
interface PolarAdapterOptions {
|
|
613
|
-
readonly client: PolarClientLike;
|
|
614
|
-
readonly webhookSecret: string;
|
|
615
|
-
readonly webhookToleranceSeconds?: number;
|
|
616
|
-
}
|
|
617
|
-
declare const createPolarAdapter: (options: PolarAdapterOptions) => PaymentAdapter;
|
|
618
|
-
interface StripeRequestOptions {
|
|
619
|
-
readonly idempotencyKey?: string;
|
|
620
|
-
}
|
|
621
|
-
interface StripePaymentIntentLike {
|
|
622
|
-
readonly amount: number;
|
|
623
|
-
readonly amount_received?: number;
|
|
624
|
-
readonly currency: string;
|
|
625
|
-
readonly customer?: null | string;
|
|
626
|
-
readonly id: string;
|
|
627
|
-
readonly metadata?: Record<string, string>;
|
|
628
|
-
readonly status: string;
|
|
629
|
-
}
|
|
630
|
-
interface StripeSubscriptionLike {
|
|
631
|
-
readonly cancel_at_period_end?: boolean;
|
|
632
|
-
readonly current_period_end?: number;
|
|
633
|
-
readonly current_period_start?: number;
|
|
634
|
-
readonly customer?: null | string;
|
|
635
|
-
readonly id: string;
|
|
636
|
-
readonly items?: {
|
|
637
|
-
data: ReadonlyArray<{
|
|
638
|
-
price?: {
|
|
639
|
-
id?: string;
|
|
640
|
-
};
|
|
641
|
-
quantity?: number;
|
|
642
|
-
}>;
|
|
643
|
-
};
|
|
644
|
-
readonly metadata?: Record<string, string>;
|
|
645
|
-
readonly status: string;
|
|
646
|
-
}
|
|
647
|
-
/** The subset of the Stripe SDK surface this adapter calls. A real `Stripe` instance satisfies it. */
|
|
648
|
-
interface StripeClientLike {
|
|
649
|
-
readonly billing: {
|
|
650
|
-
meterEvents: {
|
|
651
|
-
create: (parameters: Record<string, unknown>, options?: StripeRequestOptions) => Promise<{
|
|
652
|
-
identifier?: string;
|
|
653
|
-
}>;
|
|
654
|
-
};
|
|
655
|
-
};
|
|
656
|
-
readonly billingPortal: {
|
|
657
|
-
sessions: {
|
|
658
|
-
create: (parameters: Record<string, unknown>) => Promise<{
|
|
659
|
-
url: string;
|
|
660
|
-
}>;
|
|
661
|
-
};
|
|
662
|
-
};
|
|
663
|
-
readonly checkout: {
|
|
664
|
-
sessions: {
|
|
665
|
-
create: (parameters: Record<string, unknown>, options?: StripeRequestOptions) => Promise<{
|
|
666
|
-
id: string;
|
|
667
|
-
url: null | string;
|
|
668
|
-
}>;
|
|
669
|
-
};
|
|
670
|
-
};
|
|
671
|
-
readonly customers: {
|
|
672
|
-
create: (parameters: Record<string, unknown>, options?: StripeRequestOptions) => Promise<{
|
|
673
|
-
email: null | string;
|
|
674
|
-
id: string;
|
|
675
|
-
}>;
|
|
676
|
-
};
|
|
677
|
-
readonly paymentIntents: {
|
|
678
|
-
cancel: (id: string, parameters?: Record<string, unknown>, options?: StripeRequestOptions) => Promise<StripePaymentIntentLike>;
|
|
679
|
-
capture: (id: string, parameters?: Record<string, unknown>, options?: StripeRequestOptions) => Promise<StripePaymentIntentLike>;
|
|
680
|
-
retrieve: (id: string) => Promise<StripePaymentIntentLike>;
|
|
681
|
-
};
|
|
682
|
-
readonly refunds: {
|
|
683
|
-
create: (parameters: Record<string, unknown>, options?: StripeRequestOptions) => Promise<{
|
|
684
|
-
id: string;
|
|
685
|
-
}>;
|
|
686
|
-
};
|
|
687
|
-
readonly subscriptions: {
|
|
688
|
-
cancel: (id: string, parameters?: Record<string, unknown>, options?: StripeRequestOptions) => Promise<StripeSubscriptionLike>;
|
|
689
|
-
retrieve: (id: string) => Promise<StripeSubscriptionLike>;
|
|
690
|
-
update: (id: string, parameters: Record<string, unknown>, options?: StripeRequestOptions) => Promise<StripeSubscriptionLike>;
|
|
691
|
-
};
|
|
692
|
-
}
|
|
693
|
-
interface StripeAdapterOptions {
|
|
694
|
-
readonly client: StripeClientLike;
|
|
695
|
-
readonly webhookSecret: string;
|
|
696
|
-
readonly webhookToleranceSeconds?: number;
|
|
697
|
-
}
|
|
698
|
-
declare const createStripeAdapter: (options: StripeAdapterOptions) => PaymentAdapter;
|
|
424
|
+
/**
|
|
425
|
+
* `ReconcileInput` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
426
|
+
* @experimental
|
|
427
|
+
*/
|
|
699
428
|
interface ReconcileInput {
|
|
700
429
|
readonly adapter: PaymentAdapter;
|
|
701
430
|
/** Optional telemetry sink — fired per drifted row and once on completion. */
|
|
@@ -704,6 +433,10 @@ interface ReconcileInput {
|
|
|
704
433
|
readonly store: PaymentStore;
|
|
705
434
|
readonly subscriptionIds?: ReadonlyArray<string>;
|
|
706
435
|
}
|
|
436
|
+
/**
|
|
437
|
+
* `ReconcileResult` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
438
|
+
* @experimental
|
|
439
|
+
*/
|
|
707
440
|
interface ReconcileResult {
|
|
708
441
|
readonly checkedPayments: number;
|
|
709
442
|
readonly checkedSubscriptions: number;
|
|
@@ -712,47 +445,79 @@ interface ReconcileResult {
|
|
|
712
445
|
readonly updatedPayments: number;
|
|
713
446
|
readonly updatedSubscriptions: number;
|
|
714
447
|
}
|
|
448
|
+
/**
|
|
449
|
+
* `reconcile` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
450
|
+
* @experimental
|
|
451
|
+
*/
|
|
715
452
|
declare const reconcile: (input: ReconcileInput) => Promise<ReconcileResult>;
|
|
453
|
+
/**
|
|
454
|
+
* `paymentTables` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
455
|
+
* @experimental
|
|
456
|
+
*/
|
|
716
457
|
declare const paymentTables: Record<string, TableDefinition>;
|
|
717
|
-
/**
|
|
458
|
+
/**
|
|
459
|
+
* Action that may advance a payment session.
|
|
460
|
+
* @experimental
|
|
461
|
+
*/
|
|
718
462
|
type PaymentAction = "authorize" | "cancel" | "capture" | "fail" | "partial_refund" | "refund";
|
|
719
|
-
/**
|
|
463
|
+
/**
|
|
464
|
+
* Action that may advance a subscription.
|
|
465
|
+
* @experimental
|
|
466
|
+
*/
|
|
720
467
|
type SubscriptionAction = "activate" | "cancel" | "mark_past_due" | "pause" | "renew" | "resume";
|
|
468
|
+
/**
|
|
469
|
+
* `PAYMENT_TERMINAL_STATES` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
470
|
+
* @experimental
|
|
471
|
+
*/
|
|
721
472
|
declare const PAYMENT_TERMINAL_STATES: ReadonlySet<PaymentState>;
|
|
473
|
+
/**
|
|
474
|
+
* `SUBSCRIPTION_TERMINAL_STATES` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
475
|
+
* @experimental
|
|
476
|
+
*/
|
|
722
477
|
declare const SUBSCRIPTION_TERMINAL_STATES: ReadonlySet<SubscriptionState>;
|
|
723
|
-
/**
|
|
478
|
+
/**
|
|
479
|
+
* Next payment state for an action, or `undefined` if the transition is illegal from `from`.
|
|
480
|
+
* @experimental
|
|
481
|
+
*/
|
|
724
482
|
declare const nextPaymentState: (from: PaymentState, action: PaymentAction) => PaymentState | undefined;
|
|
483
|
+
/**
|
|
484
|
+
* `canTransitionPayment` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
485
|
+
* @experimental
|
|
486
|
+
*/
|
|
725
487
|
declare const canTransitionPayment: (from: PaymentState, action: PaymentAction) => boolean;
|
|
726
|
-
/**
|
|
488
|
+
/**
|
|
489
|
+
* Next subscription state for an action, or `undefined` if the transition is illegal from `from`.
|
|
490
|
+
* @experimental
|
|
491
|
+
*/
|
|
727
492
|
declare const nextSubscriptionState: (from: SubscriptionState, action: SubscriptionAction) => SubscriptionState | undefined;
|
|
493
|
+
/**
|
|
494
|
+
* `canTransitionSubscription` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
495
|
+
* @experimental
|
|
496
|
+
*/
|
|
728
497
|
declare const canTransitionSubscription: (from: SubscriptionState, action: SubscriptionAction) => boolean;
|
|
498
|
+
/**
|
|
499
|
+
* `applyWebhookAction` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
500
|
+
* @experimental
|
|
501
|
+
*/
|
|
729
502
|
declare const applyWebhookAction: (store: PaymentStore, action: WebhookAction, observer?: PaymentObserver) => Promise<ApplyResult>;
|
|
730
|
-
/**
|
|
503
|
+
/**
|
|
504
|
+
* Constant-time string comparison to avoid leaking byte positions via timing.
|
|
505
|
+
*
|
|
506
|
+
* Re-exported from `shared/constant-time-equal` rather than defined here. The
|
|
507
|
+
* copy that used to live at this spot returned early on a length mismatch, so
|
|
508
|
+
* an attacker learned the expected signature's LENGTH from the response time —
|
|
509
|
+
* the exact divergence that shared file was created to stop, and which it
|
|
510
|
+
* records having already fixed once in the relay hub. It also compared by code
|
|
511
|
+
* POINT, making timing depend on surrogate boundaries; the canonical one
|
|
512
|
+
* compares per UTF-16 code unit.
|
|
513
|
+
* @experimental
|
|
514
|
+
*/
|
|
731
515
|
declare const constantTimeEqual: (a: string, b: string) => boolean;
|
|
732
|
-
declare const hmacSha256Hex: (secret: string, payload: string) => Promise<string>;
|
|
733
|
-
interface StripeSignatureParts {
|
|
734
|
-
readonly signatures: string[];
|
|
735
|
-
readonly timestamp: number;
|
|
736
|
-
}
|
|
737
|
-
/** Parse a Stripe-style `t=...,v1=...,v1=...` signature header. */
|
|
738
|
-
declare const parseStripeSignatureHeader: (header: string) => StripeSignatureParts;
|
|
739
|
-
interface VerifyStripeSignatureInput {
|
|
740
|
-
/** Injectable clock (ms since epoch) for tests. */
|
|
741
|
-
readonly now?: number;
|
|
742
|
-
/** Raw request body, exactly as received. */
|
|
743
|
-
readonly payload: string;
|
|
744
|
-
readonly secret: string;
|
|
745
|
-
/** The `Stripe-Signature` header value. */
|
|
746
|
-
readonly signatureHeader: string;
|
|
747
|
-
/** Whole-second tolerance for the signed timestamp (default 300). */
|
|
748
|
-
readonly toleranceSeconds?: number;
|
|
749
|
-
}
|
|
750
516
|
/**
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
declare const verifyStripeSignature: (input: VerifyStripeSignatureInput) => Promise<void>;
|
|
517
|
+
* `hmacSha256Hex` is part of the experimental `@lunora/payment` API and may change without a major version bump.
|
|
518
|
+
* @experimental
|
|
519
|
+
*/
|
|
520
|
+
declare const hmacSha256Hex: (secret: string, payload: string) => Promise<string>;
|
|
756
521
|
interface VerifyStandardWebhookInput {
|
|
757
522
|
/** Injectable clock (ms since epoch) for tests. */
|
|
758
523
|
readonly now?: number;
|
|
@@ -764,15 +529,31 @@ interface VerifyStandardWebhookInput {
|
|
|
764
529
|
readonly toleranceSeconds?: number;
|
|
765
530
|
/** `webhook-id` header. */
|
|
766
531
|
readonly webhookId: string;
|
|
767
|
-
/** `webhook-signature` header — space-separated `v1
|
|
532
|
+
/** `webhook-signature` header — space-separated `v1,<base64>` entries. */
|
|
768
533
|
readonly webhookSignature: string;
|
|
769
534
|
/** `webhook-timestamp` header — unix seconds as a string. */
|
|
770
535
|
readonly webhookTimestamp: string;
|
|
771
536
|
}
|
|
772
537
|
/**
|
|
773
|
-
* Verify a Standard Webhooks signature (the scheme Polar and svix use):
|
|
774
|
-
* `base64(HMAC_SHA256(key, "{id}.{timestamp}.{payload}"))` compared against the header's `v1`
|
|
775
|
-
* entries, with a replay-window check. Throws a {@link LunoraPaymentError} on any failure.
|
|
776
|
-
|
|
538
|
+
* Verify a Standard Webhooks signature (the scheme Polar and svix use):
|
|
539
|
+
* `base64(HMAC_SHA256(key, "{id}.{timestamp}.{payload}"))` compared against the header's `v1`
|
|
540
|
+
* entries, with a replay-window check. Throws a {@link LunoraPaymentError} on any failure.
|
|
541
|
+
* @experimental
|
|
542
|
+
*/
|
|
777
543
|
declare const verifyStandardWebhook: (input: VerifyStandardWebhookInput) => Promise<void>;
|
|
778
|
-
|
|
544
|
+
interface VerifyCreemSignatureInput {
|
|
545
|
+
/** Raw request body, exactly as received. */
|
|
546
|
+
readonly payload: string;
|
|
547
|
+
/** Creem webhook signing secret. */
|
|
548
|
+
readonly secret: string;
|
|
549
|
+
/** The `creem-signature` header value. */
|
|
550
|
+
readonly signature: string;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Verify a Creem webhook signature: `hex(HMAC_SHA256(secret, rawBody))` compared against the
|
|
554
|
+
* `creem-signature` header. Creem's scheme signs the raw body with no timestamp, so there is no
|
|
555
|
+
* replay-window check. Throws a {@link LunoraPaymentError} on any failure.
|
|
556
|
+
* @experimental
|
|
557
|
+
*/
|
|
558
|
+
declare const verifyCreemSignature: (input: VerifyCreemSignatureInput) => Promise<void>;
|
|
559
|
+
export { type ApplyResult, type AttachInput, type AuthorizeReference, type CancelSubscriptionOptions, type CaptureInput, type CheckInput, type CheckResult, type CheckoutInput, type CheckoutResult, type CreatePaymentOptions, type CurrencyCode, type Customer, type Entitlements, type EntitlementsConfig, type FeatureBalance, type LunoraDatabaseLike, type LunoraPayment, LunoraPaymentError, MemoryPaymentStore, type Money, type MoneyJSON, PAYMENT_TERMINAL_STATES, type PaymentAction, type PaymentAdapter, type PaymentContextLike, type PaymentDatabase, type PaymentErrorCode, type PaymentEvent, type PaymentObserver, type PaymentRow, type PaymentSession, type PaymentState, type PaymentStore, type PaymentsFromContextOptions, type PlanDefinition, type ProviderId, type ReconcileInput, type ReconcileResult, type RefundInput, SUBSCRIPTION_TERMINAL_STATES, type Subscription, type SubscriptionAction, type SubscriptionState, type TrackInput, type TrackResult, type UsageEvent, type WebhookAction, type WebhookActionType, addMoney, allocateMoney, applyWebhookAction, canTransitionPayment, canTransitionSubscription, compareMoney, constantTimeEqual, createDatabasePaymentStore, createPayment, entitlementsForReference, featureNames, formatMoney, fromMoneyJSON, hasActivePrice, hmacSha256Hex, idempotencyKey, isZeroDecimalCurrency, isZeroMoney, lunoraDatabaseToPaymentDatabase, money, nextPaymentState, nextSubscriptionState, paymentTables, paymentsFromContext, reconcile, resolveEntitlements, subtractMoney, toMoneyJSON, usagePeriodStart, verifyCreemSignature, verifyStandardWebhook, zeroMoney };
|