@fantastic.dev/better-stripe 0.29.0 → 0.30.1

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.
Files changed (158) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/MIGRATION.md +8 -0
  3. package/README.md +10 -1
  4. package/dist/client/connect/payoutActivationProof.d.ts.map +1 -1
  5. package/dist/client/connect/payoutActivationProof.js +88 -42
  6. package/dist/client/connect/payoutActivationProof.js.map +1 -1
  7. package/dist/client/connect/payoutAdoption.d.ts +3 -0
  8. package/dist/client/connect/payoutAdoption.d.ts.map +1 -1
  9. package/dist/client/connect/payoutAdoption.js +218 -183
  10. package/dist/client/connect/payoutAdoption.js.map +1 -1
  11. package/dist/client/connect/payoutAdoptionCollection.d.ts +21 -0
  12. package/dist/client/connect/payoutAdoptionCollection.d.ts.map +1 -0
  13. package/dist/client/connect/payoutAdoptionCollection.js +44 -0
  14. package/dist/client/connect/payoutAdoptionCollection.js.map +1 -0
  15. package/dist/client/connect/payoutAdoptionTestHelpers.d.ts +26 -6
  16. package/dist/client/connect/payoutAdoptionTestHelpers.d.ts.map +1 -1
  17. package/dist/client/connect/payoutExecutionTestHelpers.d.ts +13 -3
  18. package/dist/client/connect/payoutExecutionTestHelpers.d.ts.map +1 -1
  19. package/dist/client/connect/payoutLargeAdoptionTestHelpers.d.ts +3745 -0
  20. package/dist/client/connect/payoutLargeAdoptionTestHelpers.d.ts.map +1 -0
  21. package/dist/client/connect/payoutLargeAdoptionTestHelpers.js +55 -0
  22. package/dist/client/connect/payoutLargeAdoptionTestHelpers.js.map +1 -0
  23. package/dist/client/connect/payoutOutcomeBatches.d.ts +5 -0
  24. package/dist/client/connect/payoutOutcomeBatches.d.ts.map +1 -0
  25. package/dist/client/connect/payoutOutcomeBatches.js +21 -0
  26. package/dist/client/connect/payoutOutcomeBatches.js.map +1 -0
  27. package/dist/client/connect/payoutPolicyState.d.ts +14 -0
  28. package/dist/client/connect/payoutPolicyState.d.ts.map +1 -0
  29. package/dist/client/connect/payoutPolicyState.js +19 -0
  30. package/dist/client/connect/payoutPolicyState.js.map +1 -0
  31. package/dist/client/connect/payoutQualification.js +1 -1
  32. package/dist/client/connect/payoutQualification.js.map +1 -1
  33. package/dist/client/connect/payoutReconciliation.d.ts +11 -6
  34. package/dist/client/connect/payoutReconciliation.d.ts.map +1 -1
  35. package/dist/client/connect/payoutReconciliation.js +62 -16
  36. package/dist/client/connect/payoutReconciliation.js.map +1 -1
  37. package/dist/client/connect/payoutResumableProof.d.ts +17 -0
  38. package/dist/client/connect/payoutResumableProof.d.ts.map +1 -0
  39. package/dist/client/connect/payoutResumableProof.js +25 -0
  40. package/dist/client/connect/payoutResumableProof.js.map +1 -0
  41. package/dist/client/connect/payoutSyncTestHelpers.d.ts +13 -3
  42. package/dist/client/connect/payoutSyncTestHelpers.d.ts.map +1 -1
  43. package/dist/client/connect/transferReceipt.d.ts +6 -2
  44. package/dist/client/connect/transferReceipt.d.ts.map +1 -1
  45. package/dist/client/connect/transferReceipt.js +3 -3
  46. package/dist/client/connect/transferReceipt.js.map +1 -1
  47. package/dist/client/payoutPolicy.d.ts.map +1 -1
  48. package/dist/client/payoutPolicy.js +24 -14
  49. package/dist/client/payoutPolicy.js.map +1 -1
  50. package/dist/component/_generated/component.d.ts +72 -0
  51. package/dist/component/_generated/component.d.ts.map +1 -1
  52. package/dist/component/earnings/triggers.d.ts +12 -4
  53. package/dist/component/earnings/triggers.d.ts.map +1 -1
  54. package/dist/component/payoutPolicy/adoption.d.ts.map +1 -1
  55. package/dist/component/payoutPolicy/adoption.js +12 -7
  56. package/dist/component/payoutPolicy/adoption.js.map +1 -1
  57. package/dist/component/payoutPolicy/mutations.d.ts +12 -0
  58. package/dist/component/payoutPolicy/mutations.d.ts.map +1 -1
  59. package/dist/component/payoutPolicy/queries.d.ts +2 -0
  60. package/dist/component/payoutPolicy/queries.d.ts.map +1 -1
  61. package/dist/component/payoutPolicy/schema.d.ts +31 -7
  62. package/dist/component/payoutPolicy/schema.d.ts.map +1 -1
  63. package/dist/component/payoutPolicy/schema.js +2 -0
  64. package/dist/component/payoutPolicy/schema.js.map +1 -1
  65. package/dist/component/payoutRelease/adoption.d.ts +3 -1
  66. package/dist/component/payoutRelease/adoption.d.ts.map +1 -1
  67. package/dist/component/payoutRelease/adoption.js +33 -16
  68. package/dist/component/payoutRelease/adoption.js.map +1 -1
  69. package/dist/component/payoutRelease/fees.d.ts.map +1 -1
  70. package/dist/component/payoutRelease/fees.js +7 -0
  71. package/dist/component/payoutRelease/fees.js.map +1 -1
  72. package/dist/component/payoutRelease/mutations.d.ts +59 -0
  73. package/dist/component/payoutRelease/mutations.d.ts.map +1 -1
  74. package/dist/component/payoutRelease/mutations.js +25 -80
  75. package/dist/component/payoutRelease/mutations.js.map +1 -1
  76. package/dist/component/payoutRelease/outcome.d.ts +69 -0
  77. package/dist/component/payoutRelease/outcome.d.ts.map +1 -0
  78. package/dist/component/payoutRelease/outcome.js +94 -0
  79. package/dist/component/payoutRelease/outcome.js.map +1 -0
  80. package/dist/component/payoutRelease/planning.d.ts.map +1 -1
  81. package/dist/component/payoutRelease/planning.js +5 -2
  82. package/dist/component/payoutRelease/planning.js.map +1 -1
  83. package/dist/component/payoutRelease/queries.d.ts +2 -2
  84. package/dist/component/payoutRelease/queries.d.ts.map +1 -1
  85. package/dist/component/payoutRelease/queries.js +2 -0
  86. package/dist/component/payoutRelease/queries.js.map +1 -1
  87. package/dist/component/payoutSnapshots/adoption.d.ts +88 -0
  88. package/dist/component/payoutSnapshots/adoption.d.ts.map +1 -0
  89. package/dist/component/payoutSnapshots/adoption.js +49 -0
  90. package/dist/component/payoutSnapshots/adoption.js.map +1 -0
  91. package/dist/component/payoutSnapshots/financial.d.ts +31 -19
  92. package/dist/component/payoutSnapshots/financial.d.ts.map +1 -1
  93. package/dist/component/payoutSnapshots/financial.js +28 -14
  94. package/dist/component/payoutSnapshots/financial.js.map +1 -1
  95. package/dist/component/payoutSnapshots/localState.d.ts +20 -16
  96. package/dist/component/payoutSnapshots/localState.d.ts.map +1 -1
  97. package/dist/component/payoutSnapshots/localState.js +13 -4
  98. package/dist/component/payoutSnapshots/localState.js.map +1 -1
  99. package/dist/component/payoutSnapshots/mutations.d.ts.map +1 -1
  100. package/dist/component/payoutSnapshots/mutations.js +1 -1
  101. package/dist/component/payoutSnapshots/mutations.js.map +1 -1
  102. package/dist/component/payoutSnapshots/queries.d.ts.map +1 -1
  103. package/dist/component/payoutSnapshots/queries.js +6 -4
  104. package/dist/component/payoutSnapshots/queries.js.map +1 -1
  105. package/dist/component/payoutSnapshots/schema.d.ts +5 -1
  106. package/dist/component/payoutSnapshots/schema.d.ts.map +1 -1
  107. package/dist/component/payoutSnapshots/schema.js +2 -0
  108. package/dist/component/payoutSnapshots/schema.js.map +1 -1
  109. package/dist/component/schema.d.ts +13 -3
  110. package/dist/react/index.d.ts +1 -0
  111. package/dist/react/index.d.ts.map +1 -1
  112. package/dist/react/index.js +1 -0
  113. package/dist/react/index.js.map +1 -1
  114. package/dist/react/lib/payout-format.d.ts +5 -0
  115. package/dist/react/lib/payout-format.d.ts.map +1 -0
  116. package/dist/react/lib/payout-format.js +13 -0
  117. package/dist/react/lib/payout-format.js.map +1 -0
  118. package/dist/react/workflows/Payouts.js +4 -4
  119. package/dist/react/workflows/Payouts.js.map +1 -1
  120. package/docs/react-workflows.md +9 -4
  121. package/docs/settlement.md +61 -8
  122. package/package.json +1 -1
  123. package/src/client/connect/payoutActivationProof.ts +123 -53
  124. package/src/client/connect/payoutAdoption.ts +299 -215
  125. package/src/client/connect/payoutAdoptionCollection.ts +78 -0
  126. package/src/client/connect/payoutAdoptionConcurrency.test.ts +266 -0
  127. package/src/client/connect/payoutCacheIdentity.test.ts +93 -0
  128. package/src/client/connect/payoutLargeAdoption.test.ts +541 -0
  129. package/src/client/connect/payoutLargeAdoptionTestHelpers.ts +74 -0
  130. package/src/client/connect/payoutOutcomeBatches.test.ts +40 -0
  131. package/src/client/connect/payoutOutcomeBatches.ts +24 -0
  132. package/src/client/connect/payoutPolicyState.ts +36 -0
  133. package/src/client/connect/payoutQualification.ts +10 -4
  134. package/src/client/connect/payoutReconciliation.ts +86 -7
  135. package/src/client/connect/payoutResumableProof.ts +41 -0
  136. package/src/client/connect/transferReceipt.ts +3 -2
  137. package/src/client/connect/transferReceiptBaseline.test.ts +55 -0
  138. package/src/client/payoutPolicy.ts +37 -23
  139. package/src/component/_generated/api.ts +4 -0
  140. package/src/component/_generated/component.ts +85 -0
  141. package/src/component/payout-snapshots.test.ts +45 -1
  142. package/src/component/payoutPolicy/adoption.ts +20 -7
  143. package/src/component/payoutPolicy/schema.ts +2 -0
  144. package/src/component/payoutRelease/adoption.ts +57 -27
  145. package/src/component/payoutRelease/fees.ts +9 -0
  146. package/src/component/payoutRelease/mutations.ts +26 -96
  147. package/src/component/payoutRelease/outcome.ts +119 -0
  148. package/src/component/payoutRelease/planning.ts +5 -2
  149. package/src/component/payoutRelease/queries.ts +2 -0
  150. package/src/component/payoutSnapshots/adoption.ts +73 -0
  151. package/src/component/payoutSnapshots/financial.ts +33 -20
  152. package/src/component/payoutSnapshots/localState.ts +17 -3
  153. package/src/component/payoutSnapshots/mutations.ts +8 -1
  154. package/src/component/payoutSnapshots/queries.ts +8 -6
  155. package/src/component/payoutSnapshots/schema.ts +2 -0
  156. package/src/react/index.ts +1 -0
  157. package/src/react/lib/payout-format.ts +16 -0
  158. package/src/react/workflows/Payouts.tsx +7 -5
@@ -1,3 +1,12 @@
1
+ import {
2
+ collectLargePayoutInput,
3
+ discardQualificationInput,
4
+ type CollectionRef,
5
+ } from "./payoutCollectedInput.js";
6
+ import {
7
+ adoptionCollectionKey,
8
+ discardAdoptionProof,
9
+ } from "./payoutAdoptionCollection.js";
1
10
  import type Stripe from "stripe";
2
11
  import type { Infer } from "convex/values";
3
12
  import type { Component, RunCtx } from "../helpers.js";
@@ -44,58 +53,119 @@ export async function collectAdoptionProof(
44
53
  | { status: "verified"; proof: Infer<typeof adoptionProof> }
45
54
  | { status: "held"; reason: string }
46
55
  > {
47
- const request = { stripeAccount: scope.accountId };
48
- const initial = await stripe.balance.retrieve(undefined, request);
49
- const first = await stripe.balanceTransactions.list({ limit: 1 }, request);
50
- const queue = new Set([
51
- ...configuredCurrencies,
52
- ...initial.available.map((t) => t.currency),
53
- ...initial.pending.map((t) => t.currency),
54
- ...(first.data[0] ? [first.data[0].currency] : []),
55
- ]);
56
- const completed = new Set<string>();
57
- let observations: Infer<typeof adoptionProof>["observations"] = [],
58
- oldestHeldAt: number | undefined;
59
- for (const currency of queue) {
60
- if (completed.size >= 50)
61
- return { status: "held", reason: "currency_history_incomplete" };
62
- const result = await adoptRecipientPayouts(
63
- stripe,
64
- component,
65
- ctx,
66
- { ...scope, currency, expectedRevision, payouts: [] },
67
- true,
68
- );
69
- if (result.status !== "adopted") return result;
70
- completed.add(currency);
71
- for (const c of result.historyCurrencies) queue.add(c);
72
- observations = result.observations;
73
- if (result.oldestHeldAt !== undefined)
74
- oldestHeldAt = Math.min(oldestHeldAt ?? Infinity, result.oldestHeldAt);
56
+ let retained: CollectionRef | undefined;
57
+ let collection:
58
+ | {
59
+ snapshotId: Infer<typeof adoptionProof>["snapshotId"];
60
+ collectionKey: string;
61
+ }
62
+ | undefined;
63
+ let handedOff = false,
64
+ keepPending = false;
65
+ try {
66
+ const request = { stripeAccount: scope.accountId };
67
+ const initial = await stripe.balance.retrieve(undefined, request);
68
+ const first = await stripe.balanceTransactions.list({ limit: 1 }, request);
69
+ const queue = new Set([
70
+ ...configuredCurrencies,
71
+ ...initial.available.map((t) => t.currency),
72
+ ...initial.pending.map((t) => t.currency),
73
+ ...(first.data[0] ? [first.data[0].currency] : []),
74
+ ]);
75
+ const completed = new Set<string>();
76
+ let observations: Infer<typeof adoptionProof>["observations"] = [],
77
+ oldestHeldAt: number | undefined;
78
+ for (const currency of queue) {
79
+ if (completed.size >= 50)
80
+ return { status: "held", reason: "currency_history_incomplete" };
81
+ const result = await adoptRecipientPayouts(
82
+ stripe,
83
+ component,
84
+ ctx,
85
+ { ...scope, currency, expectedRevision, payouts: [] },
86
+ true,
87
+ );
88
+ if (result.status !== "adopted") return result;
89
+ if (result.collection) {
90
+ if (
91
+ retained &&
92
+ retained.operationKey !== result.collection.operationKey
93
+ )
94
+ await discardQualificationInput(component, ctx, retained);
95
+ retained = result.collection;
96
+ }
97
+ completed.add(currency);
98
+ for (const c of result.historyCurrencies) queue.add(c);
99
+ observations = result.observations;
100
+ if (result.oldestHeldAt !== undefined)
101
+ oldestHeldAt = Math.min(oldestHeldAt ?? Infinity, result.oldestHeldAt);
102
+ }
103
+ let snapshot = (await ctx.runQuery(
104
+ componentRef(component, "payoutRelease/queries/snapshot"),
105
+ { accountId: scope.accountId, ownerKey: scope.ownerKey },
106
+ )) as
107
+ | { status: "ready"; claims: Infer<typeof claimDoc>[] }
108
+ | { status: "held"; reason: string };
109
+ if (snapshot.status !== "ready" || retained) {
110
+ const policy = (await ctx.runQuery(
111
+ componentRef(component, "payoutPolicy/queries/get"),
112
+ { accountId: scope.accountId, ownerKey: scope.ownerKey },
113
+ )) as { operationKey: string };
114
+ const key =
115
+ retained?.operationKey ??
116
+ (await adoptionCollectionKey(scope, policy.operationKey, "activation"));
117
+ const large = await collectLargePayoutInput(
118
+ component,
119
+ ctx,
120
+ { ...scope, operationKey: key },
121
+ 10,
122
+ );
123
+ if (large.status !== "ready") {
124
+ keepPending = large.reason === "collection_pending";
125
+ if (large.reason !== "collection_pending" && large.collection)
126
+ await discardAdoptionProof(component, ctx, scope, {
127
+ snapshotId: large.collection.snapshotId,
128
+ collectionKey: key,
129
+ });
130
+ return { status: "held", reason: large.reason };
131
+ }
132
+ collection = {
133
+ snapshotId: large.collection.snapshotId,
134
+ collectionKey: key,
135
+ };
136
+ snapshot = large;
137
+ }
138
+ const balance = await stripe.balance.retrieve(undefined, request);
139
+ const latest = await stripe.balanceTransactions.list({ limit: 1 }, request);
140
+ if (
141
+ balanceIdentity(initial) !== balanceIdentity(balance) ||
142
+ transactionIdentity(first.data[0]) !== transactionIdentity(latest.data[0])
143
+ ) {
144
+ await discardAdoptionProof(component, ctx, scope, collection);
145
+ return { status: "held", reason: "provider_changed" };
146
+ }
147
+ handedOff = true;
148
+ return {
149
+ status: "verified",
150
+ proof: {
151
+ // All discovered currencies completed verification. The final provider
152
+ // head and balances still match the initial account snapshot after local collection.
153
+ observations: observations.map((o) => ({
154
+ ...o,
155
+ observedAt: Date.now(),
156
+ })),
157
+ ...collection,
158
+ claims: snapshot.claims.map((c) => ({
159
+ operationKey: c.operationKey,
160
+ fingerprint: payoutClaimFingerprint(c),
161
+ })),
162
+ ...(oldestHeldAt !== undefined ? { oldestHeldAt } : {}),
163
+ },
164
+ };
165
+ } finally {
166
+ if (!handedOff && !keepPending) {
167
+ await discardQualificationInput(component, ctx, retained);
168
+ await discardAdoptionProof(component, ctx, scope, collection);
169
+ }
75
170
  }
76
- const balance = await stripe.balance.retrieve(undefined, request);
77
- const latest = await stripe.balanceTransactions.list({ limit: 1 }, request);
78
- if (
79
- balanceIdentity(initial) !== balanceIdentity(balance) ||
80
- transactionIdentity(first.data[0]) !== transactionIdentity(latest.data[0])
81
- )
82
- return { status: "held", reason: "provider_changed" };
83
- const snapshot = (await ctx.runQuery(
84
- componentRef(component, "payoutRelease/queries/snapshot"),
85
- { accountId: scope.accountId, ownerKey: scope.ownerKey },
86
- )) as
87
- | { status: "ready"; claims: Infer<typeof claimDoc>[] }
88
- | { status: "held"; reason: string };
89
- if (snapshot.status !== "ready") return snapshot;
90
- return {
91
- status: "verified",
92
- proof: {
93
- observations,
94
- claims: snapshot.claims.map((c) => ({
95
- operationKey: c.operationKey,
96
- fingerprint: payoutClaimFingerprint(c),
97
- })),
98
- ...(oldestHeldAt !== undefined ? { oldestHeldAt } : {}),
99
- },
100
- };
101
171
  }