Files
cfw-autumn/shared/api/core/attachModels.ts
John Yeo 238ca5d180 wip
2025-10-03 19:59:30 +01:00

196 lines
4.7 KiB
TypeScript

import { FeatureOptionsSchema } from "@models/cusProductModels/cusProductModels.js";
import { CreateFreeTrialSchema } from "@models/productModels/freeTrialModels/freeTrialModels.js";
import { ProductItemSchema } from "@models/productV2Models/productItemModels/productItemModels.js";
import { z } from "zod/v4";
import { notNullish } from "../../utils/utils.js";
import { CustomerDataSchema } from "../common/customerData.js";
import { EntityDataSchema } from "../common/entityData.js";
export const ProductOptions = z.object({
product_id: z.string(),
quantity: z.number().nullish(),
entity_id: z.string().nullish(),
options: z.array(FeatureOptionsSchema).nullish(),
});
export const ExtAttachBodySchema = z
.object({
// Customer / Entity Info
customer_id: z.string().describe("Your unique identifier for the customer"),
// Product Info
product_id: z
.string()
.nullish()
.describe(
"Product ID, set when creating the product in the Autumn dashboard",
),
entity_id: z
.string()
.nullish()
.describe(
"If attaching a product to an entity, can be used to auto create the entity",
),
customer_data: CustomerDataSchema.optional().describe(
"If auto creating a customer, the properties from this field will be used.",
),
entity_data: EntityDataSchema.optional().describe(
"If attaching a product to an entity and auto creating the entity, the properties from this field will be used. feature_id is required.",
),
product_ids: z
.array(z.string())
.min(1)
.nullish()
.describe(
"Can be used to attach multiple products to the customer at once. For example, attaching a main product and an add-on.",
),
options: z
.array(FeatureOptionsSchema)
.nullish()
.describe("Pass in quantities for prepaid features"),
free_trial: z
.boolean()
.optional()
.describe(
"If the product has a free trial, this field can be used to disable it when attaching (by passing in false)",
),
// Others
success_url: z
.string()
.optional()
.describe("URL to redirect to after the purchase is successful"),
force_checkout: z
.boolean()
.optional()
.describe(
"Always return a Stripe Checkout URL, even if the customer's card is already on file",
),
checkout_session_params: z
.any()
.optional()
.describe(
"Additional parameters to pass onto Stripe when creating the checkout session",
),
reward: z
.string()
.or(z.array(z.string()))
.optional()
.describe("An Autumn promo_code or reward_id to apply at checkout"),
invoice: z.boolean().optional(),
// Checkout params
skip_checkout: z.boolean().optional(),
setup_payment: z.boolean().optional(),
})
.meta({
example: {
customer_id: "cus_123",
product_id: "pro",
},
});
export const AttachBodySchema = ExtAttachBodySchema.extend({
products: z.array(ProductOptions).nullish(),
customer_data: CustomerDataSchema.nullish(), // For safety
// Custom Product
is_custom: z.boolean().optional(),
items: z.array(ProductItemSchema).optional(),
// Override free_trial to support CreateFreeTrialSchema
free_trial: CreateFreeTrialSchema.or(z.boolean()).optional(),
// New Version
version: z.number().optional(),
// Others
invoice_only: z.boolean().optional(),
metadata: z.any().optional(),
billing_cycle_anchor: z.number().optional(),
enable_product_immediately: z.boolean().optional(),
finalize_invoice: z.boolean().optional(),
})
.refine(
(data) => {
if (!data.product_id && !data.product_ids && !data.products) {
return false;
}
return true;
},
{
message: "`product_id` is not provided",
},
)
.refine(
(data) => {
if (data.product_id && data.product_ids) {
return false;
}
return true;
},
{
message: "provide either one `product_id` or `product_ids`",
},
)
.refine(
(data) => {
if (
notNullish(data.product_ids) &&
new Set(data.product_ids).size !== data.product_ids!.length
) {
return false;
}
return true;
},
{
message: "Can't pass in duplicate product_ids",
},
)
.refine(
(data) => {
if (data.product_ids && data.is_custom) {
return false;
}
return true;
},
{
message: "Can't pass in product_ids if is_custom is true",
},
)
.refine(
(data) => {
if (data.items && !data.is_custom) {
return false;
}
return true;
},
{
message: "Can't pass in items if is_custom is false",
},
);
export const AttachResultSchema = z.object({
customer_id: z.string(),
product_ids: z.array(z.string()),
code: z.string(),
message: z.string(),
checkout_url: z.string().nullish(),
invoice: z.any().nullish(),
});
export type AttachBody = z.infer<typeof AttachBodySchema>;
export type ProductOptions = z.infer<typeof ProductOptions>;
export type AttachResult = z.infer<typeof AttachResultSchema>;