@strimz/shared-types 0.14.0 → 0.15.0
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/dist/analytics.cjs +36 -0
- package/dist/analytics.cjs.map +1 -1
- package/dist/analytics.js +36 -0
- package/dist/analytics.js.map +1 -1
- package/dist/events.cjs +36 -0
- package/dist/events.cjs.map +1 -1
- package/dist/events.d.cts +60 -60
- package/dist/events.d.ts +60 -60
- package/dist/events.js +36 -0
- package/dist/events.js.map +1 -1
- package/dist/index.cjs +40 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +37 -1
- package/dist/index.js.map +1 -1
- package/dist/storefronts.cjs +151 -0
- package/dist/storefronts.cjs.map +1 -1
- package/dist/storefronts.js +151 -0
- package/dist/storefronts.js.map +1 -1
- package/dist/subscriptions.cjs +153 -0
- package/dist/subscriptions.cjs.map +1 -1
- package/dist/subscriptions.d.cts +80 -3
- package/dist/subscriptions.d.ts +80 -3
- package/dist/subscriptions.js +150 -1
- package/dist/subscriptions.js.map +1 -1
- package/package.json +1 -1
- package/src/subscriptions.ts +49 -0
package/dist/subscriptions.d.ts
CHANGED
|
@@ -43,6 +43,9 @@ declare const subscriptionPlanSchema: z.ZodObject<{
|
|
|
43
43
|
intervalCount: z.ZodNumber;
|
|
44
44
|
trialPeriodDays: z.ZodNullable<z.ZodNumber>;
|
|
45
45
|
status: z.ZodEnum<["active", "archived"]>;
|
|
46
|
+
/** `{SUBSCRIPTION_ID}` and `{ON_CHAIN_TX_HASH}` are filled in on redirect. */
|
|
47
|
+
successUrl: z.ZodNullable<z.ZodEffects<z.ZodString, string, string>>;
|
|
48
|
+
cancelUrl: z.ZodNullable<z.ZodEffects<z.ZodString, string, string>>;
|
|
46
49
|
metadata: z.ZodDefault<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, Record<string, string | number | boolean | null>, Record<string, string | number | boolean | null>>>;
|
|
47
50
|
createdAt: z.ZodString;
|
|
48
51
|
updatedAt: z.ZodString;
|
|
@@ -57,6 +60,8 @@ declare const subscriptionPlanSchema: z.ZodObject<{
|
|
|
57
60
|
updatedAt: string;
|
|
58
61
|
chainMerchantId: string | null;
|
|
59
62
|
tokenAddress: string | null;
|
|
63
|
+
successUrl: string | null;
|
|
64
|
+
cancelUrl: string | null;
|
|
60
65
|
metadata: Record<string, string | number | boolean | null>;
|
|
61
66
|
intervalSeconds: number;
|
|
62
67
|
name: string;
|
|
@@ -74,6 +79,8 @@ declare const subscriptionPlanSchema: z.ZodObject<{
|
|
|
74
79
|
updatedAt: string;
|
|
75
80
|
chainMerchantId: string | null;
|
|
76
81
|
tokenAddress: string | null;
|
|
82
|
+
successUrl: string | null;
|
|
83
|
+
cancelUrl: string | null;
|
|
77
84
|
intervalSeconds: number;
|
|
78
85
|
name: string;
|
|
79
86
|
interval: "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
|
|
@@ -90,6 +97,8 @@ declare const createSubscriptionPlanInputSchema: z.ZodObject<{
|
|
|
90
97
|
interval: z.ZodEnum<["daily", "weekly", "monthly", "quarterly", "yearly"]>;
|
|
91
98
|
intervalCount: z.ZodDefault<z.ZodNumber>;
|
|
92
99
|
trialPeriodDays: z.ZodOptional<z.ZodNumber>;
|
|
100
|
+
successUrl: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
|
|
101
|
+
cancelUrl: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
|
|
93
102
|
metadata: z.ZodOptional<z.ZodDefault<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, Record<string, string | number | boolean | null>, Record<string, string | number | boolean | null>>>>;
|
|
94
103
|
}, "strip", z.ZodTypeAny, {
|
|
95
104
|
amount: string;
|
|
@@ -98,6 +107,8 @@ declare const createSubscriptionPlanInputSchema: z.ZodObject<{
|
|
|
98
107
|
interval: "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
|
|
99
108
|
intervalCount: number;
|
|
100
109
|
description?: string | undefined;
|
|
110
|
+
successUrl?: string | undefined;
|
|
111
|
+
cancelUrl?: string | undefined;
|
|
101
112
|
metadata?: Record<string, string | number | boolean | null> | undefined;
|
|
102
113
|
trialPeriodDays?: number | undefined;
|
|
103
114
|
}, {
|
|
@@ -106,12 +117,78 @@ declare const createSubscriptionPlanInputSchema: z.ZodObject<{
|
|
|
106
117
|
name: string;
|
|
107
118
|
interval: "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
|
|
108
119
|
description?: string | undefined;
|
|
120
|
+
successUrl?: string | undefined;
|
|
121
|
+
cancelUrl?: string | undefined;
|
|
109
122
|
metadata?: Record<string, string | number | boolean | null> | undefined;
|
|
110
123
|
intervalCount?: number | undefined;
|
|
111
124
|
trialPeriodDays?: number | undefined;
|
|
112
125
|
}>;
|
|
113
126
|
type CreateSubscriptionPlanInput = z.input<typeof createSubscriptionPlanInputSchema>;
|
|
114
127
|
type CreateSubscriptionPlanParsed = z.output<typeof createSubscriptionPlanInputSchema>;
|
|
128
|
+
/** Price, interval and trial are fixed once a plan exists; only these change. */
|
|
129
|
+
declare const updateSubscriptionPlanInputSchema: z.ZodEffects<z.ZodObject<{
|
|
130
|
+
successUrl: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodString, string, string>>>;
|
|
131
|
+
cancelUrl: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodString, string, string>>>;
|
|
132
|
+
}, "strict", z.ZodTypeAny, {
|
|
133
|
+
successUrl?: string | null | undefined;
|
|
134
|
+
cancelUrl?: string | null | undefined;
|
|
135
|
+
}, {
|
|
136
|
+
successUrl?: string | null | undefined;
|
|
137
|
+
cancelUrl?: string | null | undefined;
|
|
138
|
+
}>, {
|
|
139
|
+
successUrl?: string | null | undefined;
|
|
140
|
+
cancelUrl?: string | null | undefined;
|
|
141
|
+
}, {
|
|
142
|
+
successUrl?: string | null | undefined;
|
|
143
|
+
cancelUrl?: string | null | undefined;
|
|
144
|
+
}>;
|
|
145
|
+
type UpdateSubscriptionPlanInput = z.input<typeof updateSubscriptionPlanInputSchema>;
|
|
146
|
+
type UpdateSubscriptionPlanParsed = z.output<typeof updateSubscriptionPlanInputSchema>;
|
|
147
|
+
declare const subscriptionResultErrorCodes: readonly ["load_failed", "merchant_not_ready", "payment_reverted", "already_subscribed"];
|
|
148
|
+
declare const subscriptionResultErrorCodeSchema: z.ZodEnum<["load_failed", "merchant_not_ready", "payment_reverted", "already_subscribed"]>;
|
|
149
|
+
type SubscriptionResultErrorCode = z.infer<typeof subscriptionResultErrorCodeSchema>;
|
|
150
|
+
/** What `/sub/{planId}` posts to the page that embedded or opened it. */
|
|
151
|
+
declare const subscriptionResultMessageSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
|
|
152
|
+
type: z.ZodLiteral<"strimz:subscription:success">;
|
|
153
|
+
planId: z.ZodString;
|
|
154
|
+
subscriptionId: z.ZodNullable<z.ZodString>;
|
|
155
|
+
txHash: z.ZodString;
|
|
156
|
+
}, "strip", z.ZodTypeAny, {
|
|
157
|
+
type: "strimz:subscription:success";
|
|
158
|
+
txHash: string;
|
|
159
|
+
planId: string;
|
|
160
|
+
subscriptionId: string | null;
|
|
161
|
+
}, {
|
|
162
|
+
type: "strimz:subscription:success";
|
|
163
|
+
txHash: string;
|
|
164
|
+
planId: string;
|
|
165
|
+
subscriptionId: string | null;
|
|
166
|
+
}>, z.ZodObject<{
|
|
167
|
+
type: z.ZodLiteral<"strimz:subscription:cancel">;
|
|
168
|
+
planId: z.ZodString;
|
|
169
|
+
}, "strip", z.ZodTypeAny, {
|
|
170
|
+
type: "strimz:subscription:cancel";
|
|
171
|
+
planId: string;
|
|
172
|
+
}, {
|
|
173
|
+
type: "strimz:subscription:cancel";
|
|
174
|
+
planId: string;
|
|
175
|
+
}>, z.ZodObject<{
|
|
176
|
+
type: z.ZodLiteral<"strimz:subscription:error">;
|
|
177
|
+
planId: z.ZodString;
|
|
178
|
+
code: z.ZodEnum<["load_failed", "merchant_not_ready", "payment_reverted", "already_subscribed"]>;
|
|
179
|
+
message: z.ZodString;
|
|
180
|
+
}, "strip", z.ZodTypeAny, {
|
|
181
|
+
code: "load_failed" | "merchant_not_ready" | "payment_reverted" | "already_subscribed";
|
|
182
|
+
message: string;
|
|
183
|
+
type: "strimz:subscription:error";
|
|
184
|
+
planId: string;
|
|
185
|
+
}, {
|
|
186
|
+
code: "load_failed" | "merchant_not_ready" | "payment_reverted" | "already_subscribed";
|
|
187
|
+
message: string;
|
|
188
|
+
type: "strimz:subscription:error";
|
|
189
|
+
planId: string;
|
|
190
|
+
}>]>;
|
|
191
|
+
type SubscriptionResultMessage = z.infer<typeof subscriptionResultMessageSchema>;
|
|
115
192
|
declare const subscriptionStatusSchema: z.ZodEnum<["trialing", "active", "at_risk", "paused", "cancelled", "lapsed"]>;
|
|
116
193
|
type SubscriptionStatus = z.infer<typeof subscriptionStatusSchema>;
|
|
117
194
|
declare const subscriptionSchema: z.ZodObject<{
|
|
@@ -148,8 +225,8 @@ declare const subscriptionSchema: z.ZodObject<{
|
|
|
148
225
|
payerAddress: string;
|
|
149
226
|
interval: "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
|
|
150
227
|
intervalCount: number;
|
|
151
|
-
onchainSubscriptionId: number | null;
|
|
152
228
|
planId: string;
|
|
229
|
+
onchainSubscriptionId: number | null;
|
|
153
230
|
trialEndsAt: string | null;
|
|
154
231
|
currentPeriodStartAt: string;
|
|
155
232
|
currentPeriodEndAt: string;
|
|
@@ -168,8 +245,8 @@ declare const subscriptionSchema: z.ZodObject<{
|
|
|
168
245
|
payerAddress: string;
|
|
169
246
|
interval: "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
|
|
170
247
|
intervalCount: number;
|
|
171
|
-
onchainSubscriptionId: number | null;
|
|
172
248
|
planId: string;
|
|
249
|
+
onchainSubscriptionId: number | null;
|
|
173
250
|
trialEndsAt: string | null;
|
|
174
251
|
currentPeriodStartAt: string;
|
|
175
252
|
currentPeriodEndAt: string;
|
|
@@ -278,4 +355,4 @@ declare const subscriptionChargeSchema: z.ZodObject<{
|
|
|
278
355
|
}>;
|
|
279
356
|
type SubscriptionCharge = z.infer<typeof subscriptionChargeSchema>;
|
|
280
357
|
|
|
281
|
-
export { type CancelSubscriptionInput, type CancelSubscriptionParsed, type CreateSubscriptionPlanInput, type CreateSubscriptionPlanParsed, type Subscription, type SubscriptionCharge, type SubscriptionChargeOutcome, type SubscriptionChargeStatus, type SubscriptionEnrolmentTerms, type SubscriptionInterval, type SubscriptionPlan, type SubscriptionPlanStatus, type SubscriptionStatus, type SubscriptionStatusResult, cancelSubscriptionInputSchema, createSubscriptionPlanInputSchema, subscriptionChargeOutcomeSchema, subscriptionChargeSchema, subscriptionChargeStatusSchema, subscriptionEnrolmentTermsSchema, subscriptionIntervalSchema, subscriptionPlanSchema, subscriptionPlanStatusSchema, subscriptionSchema, subscriptionStatusResultSchema, subscriptionStatusSchema };
|
|
358
|
+
export { type CancelSubscriptionInput, type CancelSubscriptionParsed, type CreateSubscriptionPlanInput, type CreateSubscriptionPlanParsed, type Subscription, type SubscriptionCharge, type SubscriptionChargeOutcome, type SubscriptionChargeStatus, type SubscriptionEnrolmentTerms, type SubscriptionInterval, type SubscriptionPlan, type SubscriptionPlanStatus, type SubscriptionResultErrorCode, type SubscriptionResultMessage, type SubscriptionStatus, type SubscriptionStatusResult, type UpdateSubscriptionPlanInput, type UpdateSubscriptionPlanParsed, cancelSubscriptionInputSchema, createSubscriptionPlanInputSchema, subscriptionChargeOutcomeSchema, subscriptionChargeSchema, subscriptionChargeStatusSchema, subscriptionEnrolmentTermsSchema, subscriptionIntervalSchema, subscriptionPlanSchema, subscriptionPlanStatusSchema, subscriptionResultErrorCodeSchema, subscriptionResultErrorCodes, subscriptionResultMessageSchema, subscriptionSchema, subscriptionStatusResultSchema, subscriptionStatusSchema, updateSubscriptionPlanInputSchema };
|
package/dist/subscriptions.js
CHANGED
|
@@ -26,6 +26,119 @@ var paymentCurrencySchema = z.enum(["USDC", "EURC"]);
|
|
|
26
26
|
z.enum(["USDC", "EURC", "USYC"]);
|
|
27
27
|
z.enum(["free", "starter", "growth", "enterprise"]);
|
|
28
28
|
z.enum(["testnet", "mainnet"]);
|
|
29
|
+
var paymentSessionStatusSchema = z.enum([
|
|
30
|
+
"created",
|
|
31
|
+
"awaiting_payment",
|
|
32
|
+
"submitted",
|
|
33
|
+
"confirmed",
|
|
34
|
+
"failed",
|
|
35
|
+
"expired",
|
|
36
|
+
"cancelled"
|
|
37
|
+
]);
|
|
38
|
+
var callbackUrlSchema = z.string().url().refine((v) => v.startsWith("https://") || v.startsWith("http://"), {
|
|
39
|
+
message: "must be an http:// or https:// URL"
|
|
40
|
+
});
|
|
41
|
+
z.object({
|
|
42
|
+
id: idSchema,
|
|
43
|
+
merchantId: idSchema,
|
|
44
|
+
/**
|
|
45
|
+
* On-chain StrimzRegistry merchant id (uint96) as a decimal string.
|
|
46
|
+
* Set when the merchant has been registered on-chain; null when the
|
|
47
|
+
* merchant exists in our DB but the registry transaction hasn't
|
|
48
|
+
* been broadcast yet. Hosted checkout uses this to populate the
|
|
49
|
+
* meta-tx calldata; if null, the checkout refuses to accept
|
|
50
|
+
* payments.
|
|
51
|
+
*/
|
|
52
|
+
chainMerchantId: z.string().regex(/^[0-9]+$/u, "must be a non-negative decimal integer string").nullable(),
|
|
53
|
+
/**
|
|
54
|
+
* ERC-20 token contract address resolved from `currency` on the
|
|
55
|
+
* active chain (Arc Testnet / Mainnet). Used as the `verifyingContract`
|
|
56
|
+
* in the EIP-712 domain for both EIP-3009 and EIP-2612 signing.
|
|
57
|
+
* Null on the (vanishingly unlikely) path where the API has no
|
|
58
|
+
* configured address for the session's currency.
|
|
59
|
+
*/
|
|
60
|
+
tokenAddress: evmAddressSchema.nullable(),
|
|
61
|
+
customerId: idSchema.nullable(),
|
|
62
|
+
status: paymentSessionStatusSchema,
|
|
63
|
+
amount: tokenAmountSchema,
|
|
64
|
+
currency: paymentCurrencySchema,
|
|
65
|
+
feeAmount: tokenAmountSchema,
|
|
66
|
+
netAmount: tokenAmountSchema,
|
|
67
|
+
description: z.string().max(500).nullable(),
|
|
68
|
+
payerWalletAddress: evmAddressSchema.nullable(),
|
|
69
|
+
payerEmail: z.string().email().nullable(),
|
|
70
|
+
successUrl: callbackUrlSchema.nullable(),
|
|
71
|
+
cancelUrl: callbackUrlSchema.nullable(),
|
|
72
|
+
sourceChain: z.enum(["arc", "ethereum", "base", "polygon", "arbitrum", "optimism", "avalanche", "solana"]).nullable(),
|
|
73
|
+
bridgeTxHash: evmTxHashSchema.nullable(),
|
|
74
|
+
onchainTxHash: evmTxHashSchema.nullable(),
|
|
75
|
+
checkoutUrl: z.string().url(),
|
|
76
|
+
metadata: metadataSchema,
|
|
77
|
+
expiresAt: isoTimestampSchema,
|
|
78
|
+
createdAt: isoTimestampSchema,
|
|
79
|
+
updatedAt: isoTimestampSchema
|
|
80
|
+
});
|
|
81
|
+
z.object({
|
|
82
|
+
amount: tokenAmountSchema,
|
|
83
|
+
currency: paymentCurrencySchema,
|
|
84
|
+
description: z.string().max(500).optional(),
|
|
85
|
+
customer: z.object({
|
|
86
|
+
walletAddress: evmAddressSchema.optional(),
|
|
87
|
+
email: z.string().email().optional(),
|
|
88
|
+
externalRef: z.string().max(120).optional()
|
|
89
|
+
}).optional(),
|
|
90
|
+
successUrl: callbackUrlSchema.optional(),
|
|
91
|
+
cancelUrl: callbackUrlSchema.optional(),
|
|
92
|
+
/** Minutes until the session expires. Default 30, max 60*24 (one day). */
|
|
93
|
+
expiresInMinutes: z.number().int().min(1).max(60 * 24).default(30),
|
|
94
|
+
/**
|
|
95
|
+
* Allowed source chains a payer can bridge USDC from via CCTP. Omit to
|
|
96
|
+
* accept every CCTP-supported chain.
|
|
97
|
+
*/
|
|
98
|
+
supportedSourceChains: z.array(
|
|
99
|
+
z.enum(["arc", "ethereum", "base", "polygon", "arbitrum", "optimism", "avalanche", "solana"])
|
|
100
|
+
).optional(),
|
|
101
|
+
metadata: metadataSchema.optional()
|
|
102
|
+
});
|
|
103
|
+
z.object({
|
|
104
|
+
sourceChain: z.enum([
|
|
105
|
+
"arc",
|
|
106
|
+
"ethereum",
|
|
107
|
+
"base",
|
|
108
|
+
"polygon",
|
|
109
|
+
"arbitrum",
|
|
110
|
+
"optimism",
|
|
111
|
+
"avalanche",
|
|
112
|
+
"solana"
|
|
113
|
+
]),
|
|
114
|
+
onchainTxHash: evmTxHashSchema,
|
|
115
|
+
bridgeTxHash: evmTxHashSchema.optional(),
|
|
116
|
+
payerWalletAddress: evmAddressSchema
|
|
117
|
+
});
|
|
118
|
+
var checkoutResultErrorCodes = [
|
|
119
|
+
"load_failed",
|
|
120
|
+
"merchant_not_ready",
|
|
121
|
+
"payment_reverted",
|
|
122
|
+
"unsupported_wallet"
|
|
123
|
+
];
|
|
124
|
+
var checkoutResultErrorCodeSchema = z.enum(checkoutResultErrorCodes);
|
|
125
|
+
z.discriminatedUnion("type", [
|
|
126
|
+
z.object({
|
|
127
|
+
type: z.literal("strimz:checkout:success"),
|
|
128
|
+
sessionId: idSchema,
|
|
129
|
+
txHash: evmTxHashSchema
|
|
130
|
+
}),
|
|
131
|
+
z.object({
|
|
132
|
+
type: z.literal("strimz:checkout:cancel"),
|
|
133
|
+
sessionId: idSchema
|
|
134
|
+
}),
|
|
135
|
+
z.object({
|
|
136
|
+
type: z.literal("strimz:checkout:error"),
|
|
137
|
+
sessionId: idSchema,
|
|
138
|
+
code: checkoutResultErrorCodeSchema,
|
|
139
|
+
message: z.string().min(1).max(500)
|
|
140
|
+
})
|
|
141
|
+
]);
|
|
29
142
|
|
|
30
143
|
// src/subscriptions.ts
|
|
31
144
|
var subscriptionIntervalSchema = z.enum([
|
|
@@ -65,6 +178,9 @@ var subscriptionPlanSchema = z.object({
|
|
|
65
178
|
intervalCount: z.number().int().min(1).max(365),
|
|
66
179
|
trialPeriodDays: z.number().int().min(0).max(365).nullable(),
|
|
67
180
|
status: subscriptionPlanStatusSchema,
|
|
181
|
+
/** `{SUBSCRIPTION_ID}` and `{ON_CHAIN_TX_HASH}` are filled in on redirect. */
|
|
182
|
+
successUrl: callbackUrlSchema.nullable(),
|
|
183
|
+
cancelUrl: callbackUrlSchema.nullable(),
|
|
68
184
|
metadata: metadataSchema,
|
|
69
185
|
createdAt: isoTimestampSchema,
|
|
70
186
|
updatedAt: isoTimestampSchema
|
|
@@ -77,8 +193,41 @@ var createSubscriptionPlanInputSchema = z.object({
|
|
|
77
193
|
interval: subscriptionIntervalSchema,
|
|
78
194
|
intervalCount: z.number().int().min(1).max(365).default(1),
|
|
79
195
|
trialPeriodDays: z.number().int().min(0).max(365).optional(),
|
|
196
|
+
successUrl: callbackUrlSchema.optional(),
|
|
197
|
+
cancelUrl: callbackUrlSchema.optional(),
|
|
80
198
|
metadata: metadataSchema.optional()
|
|
81
199
|
});
|
|
200
|
+
var updateSubscriptionPlanInputSchema = z.object({
|
|
201
|
+
successUrl: callbackUrlSchema.nullable().optional(),
|
|
202
|
+
cancelUrl: callbackUrlSchema.nullable().optional()
|
|
203
|
+
}).strict().refine((v) => v.successUrl !== void 0 || v.cancelUrl !== void 0, {
|
|
204
|
+
message: "set successUrl or cancelUrl"
|
|
205
|
+
});
|
|
206
|
+
var subscriptionResultErrorCodes = [
|
|
207
|
+
"load_failed",
|
|
208
|
+
"merchant_not_ready",
|
|
209
|
+
"payment_reverted",
|
|
210
|
+
"already_subscribed"
|
|
211
|
+
];
|
|
212
|
+
var subscriptionResultErrorCodeSchema = z.enum(subscriptionResultErrorCodes);
|
|
213
|
+
var subscriptionResultMessageSchema = z.discriminatedUnion("type", [
|
|
214
|
+
z.object({
|
|
215
|
+
type: z.literal("strimz:subscription:success"),
|
|
216
|
+
planId: idSchema,
|
|
217
|
+
subscriptionId: idSchema.nullable(),
|
|
218
|
+
txHash: evmTxHashSchema
|
|
219
|
+
}),
|
|
220
|
+
z.object({
|
|
221
|
+
type: z.literal("strimz:subscription:cancel"),
|
|
222
|
+
planId: idSchema
|
|
223
|
+
}),
|
|
224
|
+
z.object({
|
|
225
|
+
type: z.literal("strimz:subscription:error"),
|
|
226
|
+
planId: idSchema,
|
|
227
|
+
code: subscriptionResultErrorCodeSchema,
|
|
228
|
+
message: z.string().min(1).max(500)
|
|
229
|
+
})
|
|
230
|
+
]);
|
|
82
231
|
var subscriptionStatusSchema = z.enum([
|
|
83
232
|
"trialing",
|
|
84
233
|
"active",
|
|
@@ -163,6 +312,6 @@ var subscriptionChargeSchema = z.object({
|
|
|
163
312
|
updatedAt: isoTimestampSchema
|
|
164
313
|
});
|
|
165
314
|
|
|
166
|
-
export { cancelSubscriptionInputSchema, createSubscriptionPlanInputSchema, subscriptionChargeOutcomeSchema, subscriptionChargeSchema, subscriptionChargeStatusSchema, subscriptionEnrolmentTermsSchema, subscriptionIntervalSchema, subscriptionPlanSchema, subscriptionPlanStatusSchema, subscriptionSchema, subscriptionStatusResultSchema, subscriptionStatusSchema };
|
|
315
|
+
export { cancelSubscriptionInputSchema, createSubscriptionPlanInputSchema, subscriptionChargeOutcomeSchema, subscriptionChargeSchema, subscriptionChargeStatusSchema, subscriptionEnrolmentTermsSchema, subscriptionIntervalSchema, subscriptionPlanSchema, subscriptionPlanStatusSchema, subscriptionResultErrorCodeSchema, subscriptionResultErrorCodes, subscriptionResultMessageSchema, subscriptionSchema, subscriptionStatusResultSchema, subscriptionStatusSchema, updateSubscriptionPlanInputSchema };
|
|
167
316
|
//# sourceMappingURL=subscriptions.js.map
|
|
168
317
|
//# sourceMappingURL=subscriptions.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/common.ts","../src/subscriptions.ts"],"names":["z"],"mappings":";;;AAQO,IAAM,QAAA,GAAW,CAAA,CACrB,MAAA,EAAO,CACP,GAAA,CAAI,CAAC,CAAA,CACL,GAAA,CAAI,EAAE,CAAA,CACN,KAAA,CAAM,kBAAA,EAAoB,qBAAqB,CAAA;AAG3C,IAAM,gBAAA,GAAmB,CAAA,CAC7B,MAAA,EAAO,CACP,KAAA,CAAM,qBAAA,EAAuB,oDAAoD,CAAA,CACjF,SAAA,CAAU,CAAC,CAAA,KAAM,CAAA,CAAE,aAAa,CAAA;AAG5B,IAAM,kBAAkB,CAAA,CAC5B,MAAA,EAAO,CACP,KAAA,CAAM,uBAAuB,6DAA6D,CAAA;AAGlE,CAAA,CAAE,MAAA,EAAO,CAAE,KAAA,EAAM,CAAE,IAAA,EAAK,CAAE,WAAA,EAAY,CAAE,GAAA,CAAI,GAAG;AAG5C,CAAA,CAC3B,MAAA,EAAO,CACP,GAAA,EAAI,CACJ,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,UAAA,CAAW,UAAU,CAAA,EAAG;AAAA,EACvC,OAAA,EAAS;AACX,CAAC;AAG0B,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA;AAOjC,IAAM,oBAAoB,CAAA,CAC9B,MAAA,EAAO,CACP,KAAA,CAAM,YAAY,iDAAiD,CAAA;AAG5C,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,MAAA,CAAO,gBAAgB;AAGtE,IAAM,kBAAA,GAAqB,CAAA,CAC/B,MAAA,EAAO,CACP,QAAA,CAAS,EAAE,MAAA,EAAQ,IAAA,EAAM,OAAA,EAAS,+BAAA,EAAiC,CAAA;AAGrC,EAC9B,MAAA,EAAO,CACP,OAAO,CAAC,CAAA,CACR,KAAA,CAAM,YAAA,EAAc,0CAA0C;AAG5B,EAAE,MAAA,CAAO;AAAA,EAC5C,KAAA,EAAO,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAQ,EAAE,CAAA;AAAA,EAClD,MAAA,EAAQ,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,OAAA;AACrC,CAAC;AAaM,IAAM,iBAAiB,CAAA,CAC3B,MAAA;AAAA,EACC,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,EAAE,CAAA;AAAA,EACxB,EAAE,KAAA,CAAM,CAAC,EAAE,MAAA,EAAO,CAAE,IAAI,GAAG,CAAA,EAAG,CAAA,CAAE,MAAA,IAAU,CAAA,CAAE,OAAA,IAAW,CAAA,CAAE,IAAA,EAAM,CAAC;AAClE,CAAA,CACC,MAAA,CAAO,CAAC,CAAA,KAAM,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,CAAE,MAAA,IAAU,EAAA,EAAI,0BAA0B,CAAA,CACrE,OAAA,CAAQ,EAAE,CAAA;AAGa,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,EAAQ,MAAM,CAAC;AAI1C,IAAM,wBAAwB,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,EAAQ,MAAM,CAAC,CAAA;AAI3B,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,EAAQ,MAAA,EAAQ,MAAM,CAAC;AAI9B,EAAE,IAAA,CAAK,CAAC,QAAQ,SAAA,EAAW,QAAA,EAAU,YAAY,CAAC;AAIhD,CAAA,CAAE,IAAA,CAAK,CAAC,SAAA,EAAW,SAAS,CAAC;;;ACjF1D,IAAM,0BAAA,GAA6BA,EAAE,IAAA,CAAK;AAAA,EAC/C,OAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,WAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,+BAA+BA,CAAAA,CAAE,IAAA,CAAK,CAAC,QAAA,EAAU,UAAU,CAAC;AAGlE,IAAM,sBAAA,GAAyBA,EAAE,MAAA,CAAO;AAAA,EAC7C,EAAA,EAAI,QAAA;AAAA,EACJ,UAAA,EAAY,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOZ,eAAA,EAAiBA,EACd,MAAA,EAAO,CACP,MAAM,WAAA,EAAa,+CAA+C,EAClE,QAAA,EAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKZ,YAAA,EAAc,iBAAiB,QAAA,EAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMxC,iBAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA,EAC3C,IAAA,EAAMA,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,GAAG,CAAA;AAAA,EAC/B,aAAaA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC1C,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,QAAA,EAAU,0BAAA;AAAA,EACV,aAAA,EAAeA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA;AAAA,EAC9C,eAAA,EAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAA,EAAS;AAAA,EAC3D,MAAA,EAAQ,4BAAA;AAAA,EACR,QAAA,EAAU,cAAA;AAAA,EACV,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW;AACb,CAAC;AAGM,IAAM,iCAAA,GAAoCA,EAAE,MAAA,CAAO;AAAA,EACxD,IAAA,EAAMA,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,GAAG,CAAA;AAAA,EAC/B,aAAaA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC1C,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,QAAA,EAAU,0BAAA;AAAA,EACV,aAAA,EAAeA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAQ,CAAC,CAAA;AAAA,EACzD,eAAA,EAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAA,EAAS;AAAA,EAC3D,QAAA,EAAU,eAAe,QAAA;AAC3B,CAAC;AAMM,IAAM,wBAAA,GAA2BA,EAAE,IAAA,CAAK;AAAA,EAC7C,UAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,QAAA;AAAA,EACA,WAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,kBAAA,GAAqBA,EAAE,MAAA,CAAO;AAAA,EACzC,EAAA,EAAI,QAAA;AAAA,EACJ,qBAAA,EAAuBA,EAAE,MAAA,EAAO,CAAE,KAAI,CAAE,WAAA,GAAc,QAAA,EAAS;AAAA,EAC/D,UAAA,EAAY,QAAA;AAAA,EACZ,UAAA,EAAY,QAAA;AAAA,EACZ,MAAA,EAAQ,QAAA;AAAA,EACR,MAAA,EAAQ,wBAAA;AAAA,EACR,YAAA,EAAc,gBAAA;AAAA,EACd,QAAA,EAAU,qBAAA;AAAA,EACV,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,0BAAA;AAAA,EACV,eAAeA,CAAAA,CAAE,MAAA,GAAS,GAAA,EAAI,CAAE,IAAI,CAAC,CAAA;AAAA,EACrC,WAAA,EAAa,mBAAmB,QAAA,EAAS;AAAA,EACzC,oBAAA,EAAsB,kBAAA;AAAA,EACtB,kBAAA,EAAoB,kBAAA;AAAA,EACpB,YAAA,EAAc,mBAAmB,QAAA,EAAS;AAAA,EAC1C,gBAAA,EAAkBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,EAAE,CAAA;AAAA,EAChD,WAAA,EAAa,mBAAmB,QAAA,EAAS;AAAA,EACzC,QAAA,EAAU,cAAA;AAAA,EACV,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW;AACb,CAAC;AAIM,IAAM,8BAAA,GAAiCA,EAAE,MAAA,CAAO;AAAA,EACrD,MAAA,EAAQA,EAAE,OAAA,EAAQ;AAAA,EAClB,cAAA,EAAgB,SAAS,QAAA;AAC3B,CAAC;AAGM,IAAM,gCAAA,GAAmCA,EAAE,MAAA,CAAO;AAAA,EACvD,OAAA,EAASA,CAAAA,CAAE,MAAA,EAAO,CAAE,MAAM,OAAO,CAAA;AAAA,EACjC,WAAWA,CAAAA,CAAE,MAAA,GAAS,GAAA,EAAI,CAAE,IAAI,CAAC,CAAA;AAAA,EACjC,WAAA,EAAa,mBAAmB,QAAA;AAClC,CAAC;AAGM,IAAM,6BAAA,GAAgCA,EAAE,MAAA,CAAO;AAAA,EACpD,EAAA,EAAI,QAAA;AAAA,EACJ,QAAQA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA;AAC9B,CAAC;AAQM,IAAM,+BAAA,GAAkCA,EAAE,IAAA,CAAK;AAAA,EACpD,SAAA;AAAA,EACA,oBAAA;AAAA,EACA,kBAAA;AAAA,EACA,WAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,SAAA;AAAA,EACA,mBAAA;AAAA,EACA,iBAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,8BAAA,GAAiCA,EAAE,IAAA,CAAK;AAAA,EACnD,SAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,wBAAA,GAA2BA,EAAE,MAAA,CAAO;AAAA,EAC/C,EAAA,EAAI,QAAA;AAAA,EACJ,cAAA,EAAgB,QAAA;AAAA,EAChB,UAAA,EAAY,QAAA;AAAA,EACZ,iBAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,MAAA,CAAO,IAAI,0CAA0C,CAAA;AAAA,EACjF,aAAA,EAAe,kBAAA;AAAA,EACf,WAAA,EAAa,kBAAA;AAAA,EACb,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,MAAA,EAAQ,8BAAA;AAAA,EACR,OAAA,EAAS,gCAAgC,QAAA,EAAS;AAAA,EAClD,eAAeA,CAAAA,CAAE,MAAA,GAAS,GAAA,EAAI,CAAE,IAAI,CAAC,CAAA;AAAA,EACrC,WAAA,EAAa,kBAAA;AAAA,EACb,UAAA,EAAY,mBAAmB,QAAA,EAAS;AAAA,EACxC,aAAA,EAAe,gBAAgB,QAAA,EAAS;AAAA,EACxC,eAAeA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC5C,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW;AACb,CAAC","file":"subscriptions.js","sourcesContent":["/**\n * Primitive schemas shared across every entity.\n * Every higher-level schema builds on these so validation is consistent.\n */\n\nimport { z } from 'zod'\n\n/** CUID2 or UUID-style opaque identifier. */\nexport const idSchema = z\n .string()\n .min(1)\n .max(64)\n .regex(/^[a-zA-Z0-9_-]+$/, 'id must be URL-safe')\n\n/** EVM address. Hex-encoded, 0x-prefixed, 20 bytes. Normalised to lowercase. */\nexport const evmAddressSchema = z\n .string()\n .regex(/^0x[a-fA-F0-9]{40}$/, 'must be a 0x-prefixed 40-character hex EVM address')\n .transform((v) => v.toLowerCase())\n\n/** EVM transaction hash. 32-byte hex. */\nexport const evmTxHashSchema = z\n .string()\n .regex(/^0x[a-fA-F0-9]{64}$/, 'must be a 0x-prefixed 64-character hex EVM transaction hash')\n\n/** Email address, trimmed and lower-cased. */\nexport const emailSchema = z.string().email().trim().toLowerCase().max(320)\n\n/** HTTPS URL. No http:// allowed outside dev. */\nexport const httpsUrlSchema = z\n .string()\n .url()\n .refine((v) => v.startsWith('https://'), {\n message: 'must be an https:// URL',\n })\n\n/** URL permitting http and https (dev + prod). */\nexport const httpUrlSchema = z.string().url()\n\n/**\n * Amount expressed in the token's smallest unit, serialised as a string to\n * preserve precision beyond `Number.MAX_SAFE_INTEGER`. For USDC (6 decimals),\n * 1 USDC is the string \"1000000\".\n */\nexport const tokenAmountSchema = z\n .string()\n .regex(/^[0-9]+$/, 'must be a non-negative integer string (base-10)')\n\n/** Unsigned integer up to 2^53 - 1; validated and returned as number. */\nexport const uintSchema = z.number().int().min(0).max(Number.MAX_SAFE_INTEGER)\n\n/** ISO-8601 timestamp string (`.toISOString()`-compatible). */\nexport const isoTimestampSchema = z\n .string()\n .datetime({ offset: true, message: 'must be an ISO-8601 timestamp' })\n\n/** Two-letter ISO-3166 country code. */\nexport const countryCodeSchema = z\n .string()\n .length(2)\n .regex(/^[A-Z]{2}$/, 'must be an ISO-3166 alpha-2 country code')\n\n/** Pagination inputs used by every list endpoint. */\nexport const paginationInputSchema = z.object({\n limit: z.number().int().min(1).max(100).default(25),\n cursor: z.string().min(1).max(200).nullish(),\n})\nexport type PaginationInput = z.input<typeof paginationInputSchema>\nexport type PaginationParsed = z.output<typeof paginationInputSchema>\n\n/** Pagination envelope used by every list response. */\nexport const makePaginatedSchema = <T extends z.ZodTypeAny>(item: T) =>\n z.object({\n data: z.array(item),\n nextCursor: z.string().nullable(),\n hasMore: z.boolean(),\n })\n\n/** Free-form metadata bag the API round-trips for merchants. */\nexport const metadataSchema = z\n .record(\n z.string().min(1).max(40),\n z.union([z.string().max(500), z.number(), z.boolean(), z.null()]),\n )\n .refine((m) => Object.keys(m).length <= 50, 'at most 50 metadata keys')\n .default({})\n\n/** Environment mode carried on every mode-scoped resource. */\nexport const modeSchema = z.enum(['test', 'live'])\nexport type Mode = z.infer<typeof modeSchema>\n\n/** Payment token enum. */\nexport const paymentCurrencySchema = z.enum(['USDC', 'EURC'])\nexport type PaymentCurrency = z.infer<typeof paymentCurrencySchema>\n\n/** Every display-level currency (payment + treasury). */\nexport const tokenSymbolSchema = z.enum(['USDC', 'EURC', 'USYC'])\nexport type TokenSymbol = z.infer<typeof tokenSymbolSchema>\n\n/** Merchant tier enum. */\nexport const merchantTierSchema = z.enum(['free', 'starter', 'growth', 'enterprise'])\nexport type MerchantTier = z.infer<typeof merchantTierSchema>\n\n/** Arc environment enum. */\nexport const arcEnvironmentSchema = z.enum(['testnet', 'mainnet'])\nexport type ArcEnvironment = z.infer<typeof arcEnvironmentSchema>\n\nexport type Id = z.infer<typeof idSchema>\nexport type EvmAddress = z.infer<typeof evmAddressSchema>\nexport type EvmTxHash = z.infer<typeof evmTxHashSchema>\nexport type TokenAmount = z.infer<typeof tokenAmountSchema>\nexport type IsoTimestamp = z.infer<typeof isoTimestampSchema>\nexport type Metadata = z.infer<typeof metadataSchema>\n","/**\n * Subscriptions: plans, active subscriptions, and individual charges.\n *\n * Design notes:\n * - A SubscriptionPlan is the template a merchant defines.\n * - A Subscription is an active, customer-scoped instance of a plan.\n * - Each billing period produces a SubscriptionCharge with a unique\n * chargeAttemptId used to enforce idempotency at the contract level.\n */\n\nimport { z } from 'zod'\nimport {\n evmAddressSchema,\n evmTxHashSchema,\n idSchema,\n isoTimestampSchema,\n metadataSchema,\n paymentCurrencySchema,\n tokenAmountSchema,\n} from './common.js'\n\n// ---------- Plans ----------\n\nexport const subscriptionIntervalSchema = z.enum([\n 'daily',\n 'weekly',\n 'monthly',\n 'quarterly',\n 'yearly',\n])\nexport type SubscriptionInterval = z.infer<typeof subscriptionIntervalSchema>\n\nexport const subscriptionPlanStatusSchema = z.enum(['active', 'archived'])\nexport type SubscriptionPlanStatus = z.infer<typeof subscriptionPlanStatusSchema>\n\nexport const subscriptionPlanSchema = z.object({\n id: idSchema,\n merchantId: idSchema,\n /**\n * On-chain StrimzRegistry merchant id (uint96) as a decimal string.\n * See `paymentSessionSchema.chainMerchantId`. Null when the merchant\n * hasn't been registered on-chain yet. The hosted enrolment page\n * refuses to take signatures in that state.\n */\n chainMerchantId: z\n .string()\n .regex(/^[0-9]+$/u, 'must be a non-negative decimal integer string')\n .nullable(),\n /**\n * ERC-20 token contract address resolved from `currency`. This is the\n * EIP-2612 `verifyingContract` the wallet signs over.\n */\n tokenAddress: evmAddressSchema.nullable(),\n /**\n * Charge cadence in seconds, derived from `interval` + `intervalCount`\n * so the meta-tx layer can pass a uint32 to StrimzSubscriptions\n * without re-deriving the conversion on the client.\n */\n intervalSeconds: z.number().int().positive(),\n name: z.string().min(1).max(120),\n description: z.string().max(500).nullable(),\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n interval: subscriptionIntervalSchema,\n intervalCount: z.number().int().min(1).max(365),\n trialPeriodDays: z.number().int().min(0).max(365).nullable(),\n status: subscriptionPlanStatusSchema,\n metadata: metadataSchema,\n createdAt: isoTimestampSchema,\n updatedAt: isoTimestampSchema,\n})\nexport type SubscriptionPlan = z.infer<typeof subscriptionPlanSchema>\n\nexport const createSubscriptionPlanInputSchema = z.object({\n name: z.string().min(1).max(120),\n description: z.string().max(500).optional(),\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n interval: subscriptionIntervalSchema,\n intervalCount: z.number().int().min(1).max(365).default(1),\n trialPeriodDays: z.number().int().min(0).max(365).optional(),\n metadata: metadataSchema.optional(),\n})\nexport type CreateSubscriptionPlanInput = z.input<typeof createSubscriptionPlanInputSchema>\nexport type CreateSubscriptionPlanParsed = z.output<typeof createSubscriptionPlanInputSchema>\n\n// ---------- Subscriptions ----------\n\nexport const subscriptionStatusSchema = z.enum([\n 'trialing',\n 'active',\n 'at_risk',\n 'paused',\n 'cancelled',\n 'lapsed',\n])\nexport type SubscriptionStatus = z.infer<typeof subscriptionStatusSchema>\n\nexport const subscriptionSchema = z.object({\n id: idSchema,\n onchainSubscriptionId: z.number().int().nonnegative().nullable(),\n merchantId: idSchema,\n customerId: idSchema,\n planId: idSchema,\n status: subscriptionStatusSchema,\n payerAddress: evmAddressSchema,\n currency: paymentCurrencySchema,\n amount: tokenAmountSchema,\n interval: subscriptionIntervalSchema,\n intervalCount: z.number().int().min(1),\n trialEndsAt: isoTimestampSchema.nullable(),\n currentPeriodStartAt: isoTimestampSchema,\n currentPeriodEndAt: isoTimestampSchema,\n nextChargeAt: isoTimestampSchema.nullable(),\n gracePeriodHours: z.number().int().min(0).max(72),\n cancelledAt: isoTimestampSchema.nullable(),\n metadata: metadataSchema,\n createdAt: isoTimestampSchema,\n updatedAt: isoTimestampSchema,\n})\nexport type Subscription = z.infer<typeof subscriptionSchema>\n\n/** Whether a wallet already subscribes to a given plan, and which one. */\nexport const subscriptionStatusResultSchema = z.object({\n active: z.boolean(),\n subscriptionId: idSchema.nullable(),\n})\nexport type SubscriptionStatusResult = z.infer<typeof subscriptionStatusResultSchema>\n\nexport const subscriptionEnrolmentTermsSchema = z.object({\n startAt: z.string().regex(/^\\d+$/),\n trialDays: z.number().int().min(0),\n trialEndsAt: isoTimestampSchema.nullable(),\n})\nexport type SubscriptionEnrolmentTerms = z.infer<typeof subscriptionEnrolmentTermsSchema>\n\nexport const cancelSubscriptionInputSchema = z.object({\n id: idSchema,\n reason: z.string().max(500).optional(),\n})\nexport type CancelSubscriptionInput = z.input<typeof cancelSubscriptionInputSchema>\nexport type CancelSubscriptionParsed = z.output<typeof cancelSubscriptionInputSchema>\n\n// ---------- Charges ----------\n\n// One value per contract ChargeOutcome. `skipped` is the fallback for\n// outcomes a future contract appends.\nexport const subscriptionChargeOutcomeSchema = z.enum([\n 'charged',\n 'insufficient_funds',\n 'revoked_approval',\n 'cancelled',\n 'not_due',\n 'ended',\n 'duplicate',\n 'unknown',\n 'merchant_inactive',\n 'transfer_failed',\n 'skipped',\n])\nexport type SubscriptionChargeOutcome = z.infer<typeof subscriptionChargeOutcomeSchema>\n\nexport const subscriptionChargeStatusSchema = z.enum([\n 'pending',\n 'in_flight',\n 'succeeded',\n 'failed',\n 'retrying',\n 'abandoned',\n])\nexport type SubscriptionChargeStatus = z.infer<typeof subscriptionChargeStatusSchema>\n\nexport const subscriptionChargeSchema = z.object({\n id: idSchema,\n subscriptionId: idSchema,\n merchantId: idSchema,\n chargeAttemptId: z.string().length(66, 'must be a 32-byte 0x-prefixed hex string'),\n periodStartAt: isoTimestampSchema,\n periodEndAt: isoTimestampSchema,\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n status: subscriptionChargeStatusSchema,\n outcome: subscriptionChargeOutcomeSchema.nullable(),\n attemptNumber: z.number().int().min(1),\n scheduledAt: isoTimestampSchema,\n executedAt: isoTimestampSchema.nullable(),\n onchainTxHash: evmTxHashSchema.nullable(),\n failureReason: z.string().max(500).nullable(),\n createdAt: isoTimestampSchema,\n updatedAt: isoTimestampSchema,\n})\nexport type SubscriptionCharge = z.infer<typeof subscriptionChargeSchema>\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/common.ts","../src/payment-sessions.ts","../src/subscriptions.ts"],"names":["z"],"mappings":";;;AAQO,IAAM,QAAA,GAAW,CAAA,CACrB,MAAA,EAAO,CACP,GAAA,CAAI,CAAC,CAAA,CACL,GAAA,CAAI,EAAE,CAAA,CACN,KAAA,CAAM,kBAAA,EAAoB,qBAAqB,CAAA;AAG3C,IAAM,gBAAA,GAAmB,CAAA,CAC7B,MAAA,EAAO,CACP,KAAA,CAAM,qBAAA,EAAuB,oDAAoD,CAAA,CACjF,SAAA,CAAU,CAAC,CAAA,KAAM,CAAA,CAAE,aAAa,CAAA;AAG5B,IAAM,kBAAkB,CAAA,CAC5B,MAAA,EAAO,CACP,KAAA,CAAM,uBAAuB,6DAA6D,CAAA;AAGlE,CAAA,CAAE,MAAA,EAAO,CAAE,KAAA,EAAM,CAAE,IAAA,EAAK,CAAE,WAAA,EAAY,CAAE,GAAA,CAAI,GAAG;AAG5C,CAAA,CAC3B,MAAA,EAAO,CACP,GAAA,EAAI,CACJ,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,UAAA,CAAW,UAAU,CAAA,EAAG;AAAA,EACvC,OAAA,EAAS;AACX,CAAC;AAG0B,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA;AAOjC,IAAM,oBAAoB,CAAA,CAC9B,MAAA,EAAO,CACP,KAAA,CAAM,YAAY,iDAAiD,CAAA;AAG5C,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,MAAA,CAAO,gBAAgB;AAGtE,IAAM,kBAAA,GAAqB,CAAA,CAC/B,MAAA,EAAO,CACP,QAAA,CAAS,EAAE,MAAA,EAAQ,IAAA,EAAM,OAAA,EAAS,+BAAA,EAAiC,CAAA;AAGrC,EAC9B,MAAA,EAAO,CACP,OAAO,CAAC,CAAA,CACR,KAAA,CAAM,YAAA,EAAc,0CAA0C;AAG5B,EAAE,MAAA,CAAO;AAAA,EAC5C,KAAA,EAAO,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAQ,EAAE,CAAA;AAAA,EAClD,MAAA,EAAQ,CAAA,CAAE,MAAA,EAAO,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,OAAA;AACrC,CAAC;AAaM,IAAM,iBAAiB,CAAA,CAC3B,MAAA;AAAA,EACC,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,EAAE,CAAA;AAAA,EACxB,EAAE,KAAA,CAAM,CAAC,EAAE,MAAA,EAAO,CAAE,IAAI,GAAG,CAAA,EAAG,CAAA,CAAE,MAAA,IAAU,CAAA,CAAE,OAAA,IAAW,CAAA,CAAE,IAAA,EAAM,CAAC;AAClE,CAAA,CACC,MAAA,CAAO,CAAC,CAAA,KAAM,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,CAAE,MAAA,IAAU,EAAA,EAAI,0BAA0B,CAAA,CACrE,OAAA,CAAQ,EAAE,CAAA;AAGa,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,EAAQ,MAAM,CAAC;AAI1C,IAAM,wBAAwB,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,EAAQ,MAAM,CAAC,CAAA;AAI3B,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,EAAQ,MAAA,EAAQ,MAAM,CAAC;AAI9B,EAAE,IAAA,CAAK,CAAC,QAAQ,SAAA,EAAW,QAAA,EAAU,YAAY,CAAC;AAIhD,CAAA,CAAE,IAAA,CAAK,CAAC,SAAA,EAAW,SAAS,CAAC;AClF1D,IAAM,0BAAA,GAA6BA,EAAE,IAAA,CAAK;AAAA,EAC/C,SAAA;AAAA,EACA,kBAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA;AACF,CAAC,CAAA;AAkBM,IAAM,oBAAoBA,CAAAA,CAC9B,MAAA,EAAO,CACP,GAAA,GACA,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,WAAW,UAAU,CAAA,IAAK,CAAA,CAAE,UAAA,CAAW,SAAS,CAAA,EAAG;AAAA,EAClE,OAAA,EAAS;AACX,CAAC,CAAA;AAEiCA,EAAE,MAAA,CAAO;AAAA,EAC3C,EAAA,EAAI,QAAA;AAAA,EACJ,UAAA,EAAY,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASZ,eAAA,EAAiBA,EACd,MAAA,EAAO,CACP,MAAM,WAAA,EAAa,+CAA+C,EAClE,QAAA,EAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQZ,YAAA,EAAc,iBAAiB,QAAA,EAAS;AAAA,EACxC,UAAA,EAAY,SAAS,QAAA,EAAS;AAAA,EAC9B,MAAA,EAAQ,0BAAA;AAAA,EACR,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,SAAA,EAAW,iBAAA;AAAA,EACX,SAAA,EAAW,iBAAA;AAAA,EACX,aAAaA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC1C,kBAAA,EAAoB,iBAAiB,QAAA,EAAS;AAAA,EAC9C,YAAYA,CAAAA,CAAE,MAAA,EAAO,CAAE,KAAA,GAAQ,QAAA,EAAS;AAAA,EACxC,UAAA,EAAY,kBAAkB,QAAA,EAAS;AAAA,EACvC,SAAA,EAAW,kBAAkB,QAAA,EAAS;AAAA,EACtC,WAAA,EAAaA,CAAAA,CACV,IAAA,CAAK,CAAC,OAAO,UAAA,EAAY,MAAA,EAAQ,SAAA,EAAW,UAAA,EAAY,UAAA,EAAY,WAAA,EAAa,QAAQ,CAAC,EAC1F,QAAA,EAAS;AAAA,EACZ,YAAA,EAAc,gBAAgB,QAAA,EAAS;AAAA,EACvC,aAAA,EAAe,gBAAgB,QAAA,EAAS;AAAA,EACxC,WAAA,EAAaA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI;AAAA,EAC5B,QAAA,EAAU,cAAA;AAAA,EACV,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW;AACb,CAAC;AAK8CA,EAAE,MAAA,CAAO;AAAA,EACtD,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,aAAaA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC1C,QAAA,EAAUA,EACP,MAAA,CAAO;AAAA,IACN,aAAA,EAAe,iBAAiB,QAAA,EAAS;AAAA,IACzC,OAAOA,CAAAA,CAAE,MAAA,EAAO,CAAE,KAAA,GAAQ,QAAA,EAAS;AAAA,IACnC,aAAaA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA;AAAS,GAC3C,EACA,QAAA,EAAS;AAAA,EACZ,UAAA,EAAY,kBAAkB,QAAA,EAAS;AAAA,EACvC,SAAA,EAAW,kBAAkB,QAAA,EAAS;AAAA;AAAA,EAEtC,gBAAA,EAAkBA,CAAAA,CACf,MAAA,EAAO,CACP,KAAI,CACJ,GAAA,CAAI,CAAC,CAAA,CACL,GAAA,CAAI,EAAA,GAAK,EAAE,CAAA,CACX,QAAQ,EAAE,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,uBAAuBA,CAAAA,CACpB,KAAA;AAAA,IACCA,CAAAA,CAAE,IAAA,CAAK,CAAC,KAAA,EAAO,UAAA,EAAY,MAAA,EAAQ,SAAA,EAAW,UAAA,EAAY,UAAA,EAAY,WAAA,EAAa,QAAQ,CAAC;AAAA,IAE7F,QAAA,EAAS;AAAA,EACZ,QAAA,EAAU,eAAe,QAAA;AAC3B,CAAC;AAI8CA,EAAE,MAAA,CAAO;AAAA,EACtD,WAAA,EAAaA,EAAE,IAAA,CAAK;AAAA,IAClB,KAAA;AAAA,IACA,UAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,UAAA;AAAA,IACA,UAAA;AAAA,IACA,WAAA;AAAA,IACA;AAAA,GACD,CAAA;AAAA,EACD,aAAA,EAAe,eAAA;AAAA,EACf,YAAA,EAAc,gBAAgB,QAAA,EAAS;AAAA,EACvC,kBAAA,EAAoB;AACtB,CAAC;AAIM,IAAM,wBAAA,GAA2B;AAAA,EACtC,aAAA;AAAA,EACA,oBAAA;AAAA,EACA,kBAAA;AAAA,EACA;AACF,CAAA;AACO,IAAM,6BAAA,GAAgCA,CAAAA,CAAE,IAAA,CAAK,wBAAwB,CAAA;AAGjCA,CAAAA,CAAE,kBAAA,CAAmB,MAAA,EAAQ;AAAA,EACtEA,EAAE,MAAA,CAAO;AAAA,IACP,IAAA,EAAMA,CAAAA,CAAE,OAAA,CAAQ,yBAAyB,CAAA;AAAA,IACzC,SAAA,EAAW,QAAA;AAAA,IACX,MAAA,EAAQ;AAAA,GACT,CAAA;AAAA,EACDA,EAAE,MAAA,CAAO;AAAA,IACP,IAAA,EAAMA,CAAAA,CAAE,OAAA,CAAQ,wBAAwB,CAAA;AAAA,IACxC,SAAA,EAAW;AAAA,GACZ,CAAA;AAAA,EACDA,EAAE,MAAA,CAAO;AAAA,IACP,IAAA,EAAMA,CAAAA,CAAE,OAAA,CAAQ,uBAAuB,CAAA;AAAA,IACvC,SAAA,EAAW,QAAA;AAAA,IACX,IAAA,EAAM,6BAAA;AAAA,IACN,OAAA,EAASA,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,GAAG;AAAA,GACnC;AACH,CAAC;;;AC7JM,IAAM,0BAAA,GAA6BA,EAAE,IAAA,CAAK;AAAA,EAC/C,OAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,WAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,+BAA+BA,CAAAA,CAAE,IAAA,CAAK,CAAC,QAAA,EAAU,UAAU,CAAC;AAGlE,IAAM,sBAAA,GAAyBA,EAAE,MAAA,CAAO;AAAA,EAC7C,EAAA,EAAI,QAAA;AAAA,EACJ,UAAA,EAAY,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOZ,eAAA,EAAiBA,EACd,MAAA,EAAO,CACP,MAAM,WAAA,EAAa,+CAA+C,EAClE,QAAA,EAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKZ,YAAA,EAAc,iBAAiB,QAAA,EAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMxC,iBAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,QAAA,EAAS;AAAA,EAC3C,IAAA,EAAMA,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,GAAG,CAAA;AAAA,EAC/B,aAAaA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC1C,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,QAAA,EAAU,0BAAA;AAAA,EACV,aAAA,EAAeA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA;AAAA,EAC9C,eAAA,EAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAA,EAAS;AAAA,EAC3D,MAAA,EAAQ,4BAAA;AAAA;AAAA,EAER,UAAA,EAAY,kBAAkB,QAAA,EAAS;AAAA,EACvC,SAAA,EAAW,kBAAkB,QAAA,EAAS;AAAA,EACtC,QAAA,EAAU,cAAA;AAAA,EACV,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW;AACb,CAAC;AAGM,IAAM,iCAAA,GAAoCA,EAAE,MAAA,CAAO;AAAA,EACxD,IAAA,EAAMA,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,GAAG,CAAA;AAAA,EAC/B,aAAaA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC1C,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,QAAA,EAAU,0BAAA;AAAA,EACV,aAAA,EAAeA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAQ,CAAC,CAAA;AAAA,EACzD,eAAA,EAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,EAAI,CAAE,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,GAAG,CAAA,CAAE,QAAA,EAAS;AAAA,EAC3D,UAAA,EAAY,kBAAkB,QAAA,EAAS;AAAA,EACvC,SAAA,EAAW,kBAAkB,QAAA,EAAS;AAAA,EACtC,QAAA,EAAU,eAAe,QAAA;AAC3B,CAAC;AAKM,IAAM,iCAAA,GAAoCA,EAC9C,MAAA,CAAO;AAAA,EACN,UAAA,EAAY,iBAAA,CAAkB,QAAA,EAAS,CAAE,QAAA,EAAS;AAAA,EAClD,SAAA,EAAW,iBAAA,CAAkB,QAAA,EAAS,CAAE,QAAA;AAC1C,CAAC,CAAA,CACA,MAAA,EAAO,CACP,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,UAAA,KAAe,MAAA,IAAa,CAAA,CAAE,SAAA,KAAc,MAAA,EAAW;AAAA,EACtE,OAAA,EAAS;AACX,CAAC;AAII,IAAM,4BAAA,GAA+B;AAAA,EAC1C,aAAA;AAAA,EACA,oBAAA;AAAA,EACA,kBAAA;AAAA,EACA;AACF;AACO,IAAM,iCAAA,GAAoCA,CAAAA,CAAE,IAAA,CAAK,4BAA4B;AAI7E,IAAM,+BAAA,GAAkCA,CAAAA,CAAE,kBAAA,CAAmB,MAAA,EAAQ;AAAA,EAC1EA,EAAE,MAAA,CAAO;AAAA,IACP,IAAA,EAAMA,CAAAA,CAAE,OAAA,CAAQ,6BAA6B,CAAA;AAAA,IAC7C,MAAA,EAAQ,QAAA;AAAA,IACR,cAAA,EAAgB,SAAS,QAAA,EAAS;AAAA,IAClC,MAAA,EAAQ;AAAA,GACT,CAAA;AAAA,EACDA,EAAE,MAAA,CAAO;AAAA,IACP,IAAA,EAAMA,CAAAA,CAAE,OAAA,CAAQ,4BAA4B,CAAA;AAAA,IAC5C,MAAA,EAAQ;AAAA,GACT,CAAA;AAAA,EACDA,EAAE,MAAA,CAAO;AAAA,IACP,IAAA,EAAMA,CAAAA,CAAE,OAAA,CAAQ,2BAA2B,CAAA;AAAA,IAC3C,MAAA,EAAQ,QAAA;AAAA,IACR,IAAA,EAAM,iCAAA;AAAA,IACN,OAAA,EAASA,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,IAAI,GAAG;AAAA,GACnC;AACH,CAAC;AAKM,IAAM,wBAAA,GAA2BA,EAAE,IAAA,CAAK;AAAA,EAC7C,UAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,QAAA;AAAA,EACA,WAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,kBAAA,GAAqBA,EAAE,MAAA,CAAO;AAAA,EACzC,EAAA,EAAI,QAAA;AAAA,EACJ,qBAAA,EAAuBA,EAAE,MAAA,EAAO,CAAE,KAAI,CAAE,WAAA,GAAc,QAAA,EAAS;AAAA,EAC/D,UAAA,EAAY,QAAA;AAAA,EACZ,UAAA,EAAY,QAAA;AAAA,EACZ,MAAA,EAAQ,QAAA;AAAA,EACR,MAAA,EAAQ,wBAAA;AAAA,EACR,YAAA,EAAc,gBAAA;AAAA,EACd,QAAA,EAAU,qBAAA;AAAA,EACV,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,0BAAA;AAAA,EACV,eAAeA,CAAAA,CAAE,MAAA,GAAS,GAAA,EAAI,CAAE,IAAI,CAAC,CAAA;AAAA,EACrC,WAAA,EAAa,mBAAmB,QAAA,EAAS;AAAA,EACzC,oBAAA,EAAsB,kBAAA;AAAA,EACtB,kBAAA,EAAoB,kBAAA;AAAA,EACpB,YAAA,EAAc,mBAAmB,QAAA,EAAS;AAAA,EAC1C,gBAAA,EAAkBA,CAAAA,CAAE,MAAA,EAAO,CAAE,GAAA,GAAM,GAAA,CAAI,CAAC,CAAA,CAAE,GAAA,CAAI,EAAE,CAAA;AAAA,EAChD,WAAA,EAAa,mBAAmB,QAAA,EAAS;AAAA,EACzC,QAAA,EAAU,cAAA;AAAA,EACV,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW;AACb,CAAC;AAIM,IAAM,8BAAA,GAAiCA,EAAE,MAAA,CAAO;AAAA,EACrD,MAAA,EAAQA,EAAE,OAAA,EAAQ;AAAA,EAClB,cAAA,EAAgB,SAAS,QAAA;AAC3B,CAAC;AAGM,IAAM,gCAAA,GAAmCA,EAAE,MAAA,CAAO;AAAA,EACvD,OAAA,EAASA,CAAAA,CAAE,MAAA,EAAO,CAAE,MAAM,OAAO,CAAA;AAAA,EACjC,WAAWA,CAAAA,CAAE,MAAA,GAAS,GAAA,EAAI,CAAE,IAAI,CAAC,CAAA;AAAA,EACjC,WAAA,EAAa,mBAAmB,QAAA;AAClC,CAAC;AAGM,IAAM,6BAAA,GAAgCA,EAAE,MAAA,CAAO;AAAA,EACpD,EAAA,EAAI,QAAA;AAAA,EACJ,QAAQA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA;AAC9B,CAAC;AAQM,IAAM,+BAAA,GAAkCA,EAAE,IAAA,CAAK;AAAA,EACpD,SAAA;AAAA,EACA,oBAAA;AAAA,EACA,kBAAA;AAAA,EACA,WAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,SAAA;AAAA,EACA,mBAAA;AAAA,EACA,iBAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,8BAAA,GAAiCA,EAAE,IAAA,CAAK;AAAA,EACnD,SAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;AAAA,EACA;AACF,CAAC;AAGM,IAAM,wBAAA,GAA2BA,EAAE,MAAA,CAAO;AAAA,EAC/C,EAAA,EAAI,QAAA;AAAA,EACJ,cAAA,EAAgB,QAAA;AAAA,EAChB,UAAA,EAAY,QAAA;AAAA,EACZ,iBAAiBA,CAAAA,CAAE,MAAA,EAAO,CAAE,MAAA,CAAO,IAAI,0CAA0C,CAAA;AAAA,EACjF,aAAA,EAAe,kBAAA;AAAA,EACf,WAAA,EAAa,kBAAA;AAAA,EACb,MAAA,EAAQ,iBAAA;AAAA,EACR,QAAA,EAAU,qBAAA;AAAA,EACV,MAAA,EAAQ,8BAAA;AAAA,EACR,OAAA,EAAS,gCAAgC,QAAA,EAAS;AAAA,EAClD,eAAeA,CAAAA,CAAE,MAAA,GAAS,GAAA,EAAI,CAAE,IAAI,CAAC,CAAA;AAAA,EACrC,WAAA,EAAa,kBAAA;AAAA,EACb,UAAA,EAAY,mBAAmB,QAAA,EAAS;AAAA,EACxC,aAAA,EAAe,gBAAgB,QAAA,EAAS;AAAA,EACxC,eAAeA,CAAAA,CAAE,MAAA,GAAS,GAAA,CAAI,GAAG,EAAE,QAAA,EAAS;AAAA,EAC5C,SAAA,EAAW,kBAAA;AAAA,EACX,SAAA,EAAW;AACb,CAAC","file":"subscriptions.js","sourcesContent":["/**\n * Primitive schemas shared across every entity.\n * Every higher-level schema builds on these so validation is consistent.\n */\n\nimport { z } from 'zod'\n\n/** CUID2 or UUID-style opaque identifier. */\nexport const idSchema = z\n .string()\n .min(1)\n .max(64)\n .regex(/^[a-zA-Z0-9_-]+$/, 'id must be URL-safe')\n\n/** EVM address. Hex-encoded, 0x-prefixed, 20 bytes. Normalised to lowercase. */\nexport const evmAddressSchema = z\n .string()\n .regex(/^0x[a-fA-F0-9]{40}$/, 'must be a 0x-prefixed 40-character hex EVM address')\n .transform((v) => v.toLowerCase())\n\n/** EVM transaction hash. 32-byte hex. */\nexport const evmTxHashSchema = z\n .string()\n .regex(/^0x[a-fA-F0-9]{64}$/, 'must be a 0x-prefixed 64-character hex EVM transaction hash')\n\n/** Email address, trimmed and lower-cased. */\nexport const emailSchema = z.string().email().trim().toLowerCase().max(320)\n\n/** HTTPS URL. No http:// allowed outside dev. */\nexport const httpsUrlSchema = z\n .string()\n .url()\n .refine((v) => v.startsWith('https://'), {\n message: 'must be an https:// URL',\n })\n\n/** URL permitting http and https (dev + prod). */\nexport const httpUrlSchema = z.string().url()\n\n/**\n * Amount expressed in the token's smallest unit, serialised as a string to\n * preserve precision beyond `Number.MAX_SAFE_INTEGER`. For USDC (6 decimals),\n * 1 USDC is the string \"1000000\".\n */\nexport const tokenAmountSchema = z\n .string()\n .regex(/^[0-9]+$/, 'must be a non-negative integer string (base-10)')\n\n/** Unsigned integer up to 2^53 - 1; validated and returned as number. */\nexport const uintSchema = z.number().int().min(0).max(Number.MAX_SAFE_INTEGER)\n\n/** ISO-8601 timestamp string (`.toISOString()`-compatible). */\nexport const isoTimestampSchema = z\n .string()\n .datetime({ offset: true, message: 'must be an ISO-8601 timestamp' })\n\n/** Two-letter ISO-3166 country code. */\nexport const countryCodeSchema = z\n .string()\n .length(2)\n .regex(/^[A-Z]{2}$/, 'must be an ISO-3166 alpha-2 country code')\n\n/** Pagination inputs used by every list endpoint. */\nexport const paginationInputSchema = z.object({\n limit: z.number().int().min(1).max(100).default(25),\n cursor: z.string().min(1).max(200).nullish(),\n})\nexport type PaginationInput = z.input<typeof paginationInputSchema>\nexport type PaginationParsed = z.output<typeof paginationInputSchema>\n\n/** Pagination envelope used by every list response. */\nexport const makePaginatedSchema = <T extends z.ZodTypeAny>(item: T) =>\n z.object({\n data: z.array(item),\n nextCursor: z.string().nullable(),\n hasMore: z.boolean(),\n })\n\n/** Free-form metadata bag the API round-trips for merchants. */\nexport const metadataSchema = z\n .record(\n z.string().min(1).max(40),\n z.union([z.string().max(500), z.number(), z.boolean(), z.null()]),\n )\n .refine((m) => Object.keys(m).length <= 50, 'at most 50 metadata keys')\n .default({})\n\n/** Environment mode carried on every mode-scoped resource. */\nexport const modeSchema = z.enum(['test', 'live'])\nexport type Mode = z.infer<typeof modeSchema>\n\n/** Payment token enum. */\nexport const paymentCurrencySchema = z.enum(['USDC', 'EURC'])\nexport type PaymentCurrency = z.infer<typeof paymentCurrencySchema>\n\n/** Every display-level currency (payment + treasury). */\nexport const tokenSymbolSchema = z.enum(['USDC', 'EURC', 'USYC'])\nexport type TokenSymbol = z.infer<typeof tokenSymbolSchema>\n\n/** Merchant tier enum. */\nexport const merchantTierSchema = z.enum(['free', 'starter', 'growth', 'enterprise'])\nexport type MerchantTier = z.infer<typeof merchantTierSchema>\n\n/** Arc environment enum. */\nexport const arcEnvironmentSchema = z.enum(['testnet', 'mainnet'])\nexport type ArcEnvironment = z.infer<typeof arcEnvironmentSchema>\n\nexport type Id = z.infer<typeof idSchema>\nexport type EvmAddress = z.infer<typeof evmAddressSchema>\nexport type EvmTxHash = z.infer<typeof evmTxHashSchema>\nexport type TokenAmount = z.infer<typeof tokenAmountSchema>\nexport type IsoTimestamp = z.infer<typeof isoTimestampSchema>\nexport type Metadata = z.infer<typeof metadataSchema>\n","/**\n * Payment session. A one-shot checkout intent.\n *\n * State machine:\n * created → awaiting_payment → submitted → confirmed\n * \\\n * → failed\n * → expired\n * → cancelled\n */\n\nimport { z } from 'zod'\nimport {\n evmAddressSchema,\n evmTxHashSchema,\n idSchema,\n isoTimestampSchema,\n metadataSchema,\n paymentCurrencySchema,\n tokenAmountSchema,\n} from './common.js'\n\nexport const paymentSessionStatusSchema = z.enum([\n 'created',\n 'awaiting_payment',\n 'submitted',\n 'confirmed',\n 'failed',\n 'expired',\n 'cancelled',\n])\nexport type PaymentSessionStatus = z.infer<typeof paymentSessionStatusSchema>\n\n/**\n * Merchant-supplied callback URL. The hosted checkout dispatches with\n * `window.location.href = redirectUrl` on completion / cancellation,\n * so we MUST reject anything other than `http://` and `https://`.\n *\n * Why this is a real risk: Zod's `.url()` validates RFC syntax, which\n * accepts `javascript:`, `data:`, `vbscript:`, `file:`, blob:`, etc.\n * A compromised merchant integration or an XSS upstream could ship a\n * session whose redirect URL executes script (or exfiltrates session\n * tokens) on every payer's browser. The damage is per-payer, but the\n * blast radius is \"every checkout the merchant runs.\"\n *\n * Mailto / tel and other handler protocols are also rejected — there\n * is no legitimate flow on a payment checkout that would benefit.\n */\nexport const callbackUrlSchema = z\n .string()\n .url()\n .refine((v) => v.startsWith('https://') || v.startsWith('http://'), {\n message: 'must be an http:// or https:// URL',\n })\n\nexport const paymentSessionSchema = z.object({\n id: idSchema,\n merchantId: idSchema,\n /**\n * On-chain StrimzRegistry merchant id (uint96) as a decimal string.\n * Set when the merchant has been registered on-chain; null when the\n * merchant exists in our DB but the registry transaction hasn't\n * been broadcast yet. Hosted checkout uses this to populate the\n * meta-tx calldata; if null, the checkout refuses to accept\n * payments.\n */\n chainMerchantId: z\n .string()\n .regex(/^[0-9]+$/u, 'must be a non-negative decimal integer string')\n .nullable(),\n /**\n * ERC-20 token contract address resolved from `currency` on the\n * active chain (Arc Testnet / Mainnet). Used as the `verifyingContract`\n * in the EIP-712 domain for both EIP-3009 and EIP-2612 signing.\n * Null on the (vanishingly unlikely) path where the API has no\n * configured address for the session's currency.\n */\n tokenAddress: evmAddressSchema.nullable(),\n customerId: idSchema.nullable(),\n status: paymentSessionStatusSchema,\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n feeAmount: tokenAmountSchema,\n netAmount: tokenAmountSchema,\n description: z.string().max(500).nullable(),\n payerWalletAddress: evmAddressSchema.nullable(),\n payerEmail: z.string().email().nullable(),\n successUrl: callbackUrlSchema.nullable(),\n cancelUrl: callbackUrlSchema.nullable(),\n sourceChain: z\n .enum(['arc', 'ethereum', 'base', 'polygon', 'arbitrum', 'optimism', 'avalanche', 'solana'])\n .nullable(),\n bridgeTxHash: evmTxHashSchema.nullable(),\n onchainTxHash: evmTxHashSchema.nullable(),\n checkoutUrl: z.string().url(),\n metadata: metadataSchema,\n expiresAt: isoTimestampSchema,\n createdAt: isoTimestampSchema,\n updatedAt: isoTimestampSchema,\n})\nexport type PaymentSession = z.infer<typeof paymentSessionSchema>\n\n// ---------- DTOs ----------\n\nexport const createPaymentSessionInputSchema = z.object({\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n description: z.string().max(500).optional(),\n customer: z\n .object({\n walletAddress: evmAddressSchema.optional(),\n email: z.string().email().optional(),\n externalRef: z.string().max(120).optional(),\n })\n .optional(),\n successUrl: callbackUrlSchema.optional(),\n cancelUrl: callbackUrlSchema.optional(),\n /** Minutes until the session expires. Default 30, max 60*24 (one day). */\n expiresInMinutes: z\n .number()\n .int()\n .min(1)\n .max(60 * 24)\n .default(30),\n /**\n * Allowed source chains a payer can bridge USDC from via CCTP. Omit to\n * accept every CCTP-supported chain.\n */\n supportedSourceChains: z\n .array(\n z.enum(['arc', 'ethereum', 'base', 'polygon', 'arbitrum', 'optimism', 'avalanche', 'solana']),\n )\n .optional(),\n metadata: metadataSchema.optional(),\n})\nexport type CreatePaymentSessionInput = z.input<typeof createPaymentSessionInputSchema>\nexport type CreatePaymentSessionParsed = z.output<typeof createPaymentSessionInputSchema>\n\nexport const submitPaymentSessionInputSchema = z.object({\n sourceChain: z.enum([\n 'arc',\n 'ethereum',\n 'base',\n 'polygon',\n 'arbitrum',\n 'optimism',\n 'avalanche',\n 'solana',\n ]),\n onchainTxHash: evmTxHashSchema,\n bridgeTxHash: evmTxHashSchema.optional(),\n payerWalletAddress: evmAddressSchema,\n})\nexport type SubmitPaymentSessionInput = z.input<typeof submitPaymentSessionInputSchema>\nexport type SubmitPaymentSessionParsed = z.output<typeof submitPaymentSessionInputSchema>\n\nexport const checkoutResultErrorCodes = [\n 'load_failed',\n 'merchant_not_ready',\n 'payment_reverted',\n 'unsupported_wallet',\n] as const\nexport const checkoutResultErrorCodeSchema = z.enum(checkoutResultErrorCodes)\nexport type CheckoutResultErrorCode = z.infer<typeof checkoutResultErrorCodeSchema>\n\nexport const checkoutResultMessageSchema = z.discriminatedUnion('type', [\n z.object({\n type: z.literal('strimz:checkout:success'),\n sessionId: idSchema,\n txHash: evmTxHashSchema,\n }),\n z.object({\n type: z.literal('strimz:checkout:cancel'),\n sessionId: idSchema,\n }),\n z.object({\n type: z.literal('strimz:checkout:error'),\n sessionId: idSchema,\n code: checkoutResultErrorCodeSchema,\n message: z.string().min(1).max(500),\n }),\n])\nexport type CheckoutResultMessage = z.infer<typeof checkoutResultMessageSchema>\n","/**\n * Subscriptions: plans, active subscriptions, and individual charges.\n *\n * Design notes:\n * - A SubscriptionPlan is the template a merchant defines.\n * - A Subscription is an active, customer-scoped instance of a plan.\n * - Each billing period produces a SubscriptionCharge with a unique\n * chargeAttemptId used to enforce idempotency at the contract level.\n */\n\nimport { z } from 'zod'\nimport {\n evmAddressSchema,\n evmTxHashSchema,\n idSchema,\n isoTimestampSchema,\n metadataSchema,\n paymentCurrencySchema,\n tokenAmountSchema,\n} from './common.js'\nimport { callbackUrlSchema } from './payment-sessions.js'\n\n// ---------- Plans ----------\n\nexport const subscriptionIntervalSchema = z.enum([\n 'daily',\n 'weekly',\n 'monthly',\n 'quarterly',\n 'yearly',\n])\nexport type SubscriptionInterval = z.infer<typeof subscriptionIntervalSchema>\n\nexport const subscriptionPlanStatusSchema = z.enum(['active', 'archived'])\nexport type SubscriptionPlanStatus = z.infer<typeof subscriptionPlanStatusSchema>\n\nexport const subscriptionPlanSchema = z.object({\n id: idSchema,\n merchantId: idSchema,\n /**\n * On-chain StrimzRegistry merchant id (uint96) as a decimal string.\n * See `paymentSessionSchema.chainMerchantId`. Null when the merchant\n * hasn't been registered on-chain yet. The hosted enrolment page\n * refuses to take signatures in that state.\n */\n chainMerchantId: z\n .string()\n .regex(/^[0-9]+$/u, 'must be a non-negative decimal integer string')\n .nullable(),\n /**\n * ERC-20 token contract address resolved from `currency`. This is the\n * EIP-2612 `verifyingContract` the wallet signs over.\n */\n tokenAddress: evmAddressSchema.nullable(),\n /**\n * Charge cadence in seconds, derived from `interval` + `intervalCount`\n * so the meta-tx layer can pass a uint32 to StrimzSubscriptions\n * without re-deriving the conversion on the client.\n */\n intervalSeconds: z.number().int().positive(),\n name: z.string().min(1).max(120),\n description: z.string().max(500).nullable(),\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n interval: subscriptionIntervalSchema,\n intervalCount: z.number().int().min(1).max(365),\n trialPeriodDays: z.number().int().min(0).max(365).nullable(),\n status: subscriptionPlanStatusSchema,\n /** `{SUBSCRIPTION_ID}` and `{ON_CHAIN_TX_HASH}` are filled in on redirect. */\n successUrl: callbackUrlSchema.nullable(),\n cancelUrl: callbackUrlSchema.nullable(),\n metadata: metadataSchema,\n createdAt: isoTimestampSchema,\n updatedAt: isoTimestampSchema,\n})\nexport type SubscriptionPlan = z.infer<typeof subscriptionPlanSchema>\n\nexport const createSubscriptionPlanInputSchema = z.object({\n name: z.string().min(1).max(120),\n description: z.string().max(500).optional(),\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n interval: subscriptionIntervalSchema,\n intervalCount: z.number().int().min(1).max(365).default(1),\n trialPeriodDays: z.number().int().min(0).max(365).optional(),\n successUrl: callbackUrlSchema.optional(),\n cancelUrl: callbackUrlSchema.optional(),\n metadata: metadataSchema.optional(),\n})\nexport type CreateSubscriptionPlanInput = z.input<typeof createSubscriptionPlanInputSchema>\nexport type CreateSubscriptionPlanParsed = z.output<typeof createSubscriptionPlanInputSchema>\n\n/** Price, interval and trial are fixed once a plan exists; only these change. */\nexport const updateSubscriptionPlanInputSchema = z\n .object({\n successUrl: callbackUrlSchema.nullable().optional(),\n cancelUrl: callbackUrlSchema.nullable().optional(),\n })\n .strict()\n .refine((v) => v.successUrl !== undefined || v.cancelUrl !== undefined, {\n message: 'set successUrl or cancelUrl',\n })\nexport type UpdateSubscriptionPlanInput = z.input<typeof updateSubscriptionPlanInputSchema>\nexport type UpdateSubscriptionPlanParsed = z.output<typeof updateSubscriptionPlanInputSchema>\n\nexport const subscriptionResultErrorCodes = [\n 'load_failed',\n 'merchant_not_ready',\n 'payment_reverted',\n 'already_subscribed',\n] as const\nexport const subscriptionResultErrorCodeSchema = z.enum(subscriptionResultErrorCodes)\nexport type SubscriptionResultErrorCode = z.infer<typeof subscriptionResultErrorCodeSchema>\n\n/** What `/sub/{planId}` posts to the page that embedded or opened it. */\nexport const subscriptionResultMessageSchema = z.discriminatedUnion('type', [\n z.object({\n type: z.literal('strimz:subscription:success'),\n planId: idSchema,\n subscriptionId: idSchema.nullable(),\n txHash: evmTxHashSchema,\n }),\n z.object({\n type: z.literal('strimz:subscription:cancel'),\n planId: idSchema,\n }),\n z.object({\n type: z.literal('strimz:subscription:error'),\n planId: idSchema,\n code: subscriptionResultErrorCodeSchema,\n message: z.string().min(1).max(500),\n }),\n])\nexport type SubscriptionResultMessage = z.infer<typeof subscriptionResultMessageSchema>\n\n// ---------- Subscriptions ----------\n\nexport const subscriptionStatusSchema = z.enum([\n 'trialing',\n 'active',\n 'at_risk',\n 'paused',\n 'cancelled',\n 'lapsed',\n])\nexport type SubscriptionStatus = z.infer<typeof subscriptionStatusSchema>\n\nexport const subscriptionSchema = z.object({\n id: idSchema,\n onchainSubscriptionId: z.number().int().nonnegative().nullable(),\n merchantId: idSchema,\n customerId: idSchema,\n planId: idSchema,\n status: subscriptionStatusSchema,\n payerAddress: evmAddressSchema,\n currency: paymentCurrencySchema,\n amount: tokenAmountSchema,\n interval: subscriptionIntervalSchema,\n intervalCount: z.number().int().min(1),\n trialEndsAt: isoTimestampSchema.nullable(),\n currentPeriodStartAt: isoTimestampSchema,\n currentPeriodEndAt: isoTimestampSchema,\n nextChargeAt: isoTimestampSchema.nullable(),\n gracePeriodHours: z.number().int().min(0).max(72),\n cancelledAt: isoTimestampSchema.nullable(),\n metadata: metadataSchema,\n createdAt: isoTimestampSchema,\n updatedAt: isoTimestampSchema,\n})\nexport type Subscription = z.infer<typeof subscriptionSchema>\n\n/** Whether a wallet already subscribes to a given plan, and which one. */\nexport const subscriptionStatusResultSchema = z.object({\n active: z.boolean(),\n subscriptionId: idSchema.nullable(),\n})\nexport type SubscriptionStatusResult = z.infer<typeof subscriptionStatusResultSchema>\n\nexport const subscriptionEnrolmentTermsSchema = z.object({\n startAt: z.string().regex(/^\\d+$/),\n trialDays: z.number().int().min(0),\n trialEndsAt: isoTimestampSchema.nullable(),\n})\nexport type SubscriptionEnrolmentTerms = z.infer<typeof subscriptionEnrolmentTermsSchema>\n\nexport const cancelSubscriptionInputSchema = z.object({\n id: idSchema,\n reason: z.string().max(500).optional(),\n})\nexport type CancelSubscriptionInput = z.input<typeof cancelSubscriptionInputSchema>\nexport type CancelSubscriptionParsed = z.output<typeof cancelSubscriptionInputSchema>\n\n// ---------- Charges ----------\n\n// One value per contract ChargeOutcome. `skipped` is the fallback for\n// outcomes a future contract appends.\nexport const subscriptionChargeOutcomeSchema = z.enum([\n 'charged',\n 'insufficient_funds',\n 'revoked_approval',\n 'cancelled',\n 'not_due',\n 'ended',\n 'duplicate',\n 'unknown',\n 'merchant_inactive',\n 'transfer_failed',\n 'skipped',\n])\nexport type SubscriptionChargeOutcome = z.infer<typeof subscriptionChargeOutcomeSchema>\n\nexport const subscriptionChargeStatusSchema = z.enum([\n 'pending',\n 'in_flight',\n 'succeeded',\n 'failed',\n 'retrying',\n 'abandoned',\n])\nexport type SubscriptionChargeStatus = z.infer<typeof subscriptionChargeStatusSchema>\n\nexport const subscriptionChargeSchema = z.object({\n id: idSchema,\n subscriptionId: idSchema,\n merchantId: idSchema,\n chargeAttemptId: z.string().length(66, 'must be a 32-byte 0x-prefixed hex string'),\n periodStartAt: isoTimestampSchema,\n periodEndAt: isoTimestampSchema,\n amount: tokenAmountSchema,\n currency: paymentCurrencySchema,\n status: subscriptionChargeStatusSchema,\n outcome: subscriptionChargeOutcomeSchema.nullable(),\n attemptNumber: z.number().int().min(1),\n scheduledAt: isoTimestampSchema,\n executedAt: isoTimestampSchema.nullable(),\n onchainTxHash: evmTxHashSchema.nullable(),\n failureReason: z.string().max(500).nullable(),\n createdAt: isoTimestampSchema,\n updatedAt: isoTimestampSchema,\n})\nexport type SubscriptionCharge = z.infer<typeof subscriptionChargeSchema>\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@strimz/shared-types",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.15.0",
|
|
4
4
|
"description": "Zod schemas and inferred TypeScript types for every Strimz platform entity, API input, and webhook event.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Strimz <hello@strimz.finance>",
|
package/src/subscriptions.ts
CHANGED
|
@@ -18,6 +18,7 @@ import {
|
|
|
18
18
|
paymentCurrencySchema,
|
|
19
19
|
tokenAmountSchema,
|
|
20
20
|
} from './common.js'
|
|
21
|
+
import { callbackUrlSchema } from './payment-sessions.js'
|
|
21
22
|
|
|
22
23
|
// ---------- Plans ----------
|
|
23
24
|
|
|
@@ -65,6 +66,9 @@ export const subscriptionPlanSchema = z.object({
|
|
|
65
66
|
intervalCount: z.number().int().min(1).max(365),
|
|
66
67
|
trialPeriodDays: z.number().int().min(0).max(365).nullable(),
|
|
67
68
|
status: subscriptionPlanStatusSchema,
|
|
69
|
+
/** `{SUBSCRIPTION_ID}` and `{ON_CHAIN_TX_HASH}` are filled in on redirect. */
|
|
70
|
+
successUrl: callbackUrlSchema.nullable(),
|
|
71
|
+
cancelUrl: callbackUrlSchema.nullable(),
|
|
68
72
|
metadata: metadataSchema,
|
|
69
73
|
createdAt: isoTimestampSchema,
|
|
70
74
|
updatedAt: isoTimestampSchema,
|
|
@@ -79,11 +83,56 @@ export const createSubscriptionPlanInputSchema = z.object({
|
|
|
79
83
|
interval: subscriptionIntervalSchema,
|
|
80
84
|
intervalCount: z.number().int().min(1).max(365).default(1),
|
|
81
85
|
trialPeriodDays: z.number().int().min(0).max(365).optional(),
|
|
86
|
+
successUrl: callbackUrlSchema.optional(),
|
|
87
|
+
cancelUrl: callbackUrlSchema.optional(),
|
|
82
88
|
metadata: metadataSchema.optional(),
|
|
83
89
|
})
|
|
84
90
|
export type CreateSubscriptionPlanInput = z.input<typeof createSubscriptionPlanInputSchema>
|
|
85
91
|
export type CreateSubscriptionPlanParsed = z.output<typeof createSubscriptionPlanInputSchema>
|
|
86
92
|
|
|
93
|
+
/** Price, interval and trial are fixed once a plan exists; only these change. */
|
|
94
|
+
export const updateSubscriptionPlanInputSchema = z
|
|
95
|
+
.object({
|
|
96
|
+
successUrl: callbackUrlSchema.nullable().optional(),
|
|
97
|
+
cancelUrl: callbackUrlSchema.nullable().optional(),
|
|
98
|
+
})
|
|
99
|
+
.strict()
|
|
100
|
+
.refine((v) => v.successUrl !== undefined || v.cancelUrl !== undefined, {
|
|
101
|
+
message: 'set successUrl or cancelUrl',
|
|
102
|
+
})
|
|
103
|
+
export type UpdateSubscriptionPlanInput = z.input<typeof updateSubscriptionPlanInputSchema>
|
|
104
|
+
export type UpdateSubscriptionPlanParsed = z.output<typeof updateSubscriptionPlanInputSchema>
|
|
105
|
+
|
|
106
|
+
export const subscriptionResultErrorCodes = [
|
|
107
|
+
'load_failed',
|
|
108
|
+
'merchant_not_ready',
|
|
109
|
+
'payment_reverted',
|
|
110
|
+
'already_subscribed',
|
|
111
|
+
] as const
|
|
112
|
+
export const subscriptionResultErrorCodeSchema = z.enum(subscriptionResultErrorCodes)
|
|
113
|
+
export type SubscriptionResultErrorCode = z.infer<typeof subscriptionResultErrorCodeSchema>
|
|
114
|
+
|
|
115
|
+
/** What `/sub/{planId}` posts to the page that embedded or opened it. */
|
|
116
|
+
export const subscriptionResultMessageSchema = z.discriminatedUnion('type', [
|
|
117
|
+
z.object({
|
|
118
|
+
type: z.literal('strimz:subscription:success'),
|
|
119
|
+
planId: idSchema,
|
|
120
|
+
subscriptionId: idSchema.nullable(),
|
|
121
|
+
txHash: evmTxHashSchema,
|
|
122
|
+
}),
|
|
123
|
+
z.object({
|
|
124
|
+
type: z.literal('strimz:subscription:cancel'),
|
|
125
|
+
planId: idSchema,
|
|
126
|
+
}),
|
|
127
|
+
z.object({
|
|
128
|
+
type: z.literal('strimz:subscription:error'),
|
|
129
|
+
planId: idSchema,
|
|
130
|
+
code: subscriptionResultErrorCodeSchema,
|
|
131
|
+
message: z.string().min(1).max(500),
|
|
132
|
+
}),
|
|
133
|
+
])
|
|
134
|
+
export type SubscriptionResultMessage = z.infer<typeof subscriptionResultMessageSchema>
|
|
135
|
+
|
|
87
136
|
// ---------- Subscriptions ----------
|
|
88
137
|
|
|
89
138
|
export const subscriptionStatusSchema = z.enum([
|