@intlayer/backend-contract 0.0.0-stage → 9.6.0

package/dist/esm/stripe.mjs

@@ -0,0 +1,379 @@
+import { defineRoute, defineRouteGroup } from "./defineRoute.mjs";
+import { paginatedResponseSchema, responseDataSchema } from "./responseData.mjs";
+import { dateTimeSchema, objectIdSchema, paginationQueryShape } from "./common.mjs";
+import { planSchema } from "./organization.mjs";
+import { z } from "zod/mini";
+
+//#region src/stripe.ts
+/** Stripe invoice. */
+const stripeInvoiceSchema = z.looseObject({
+	id: z.optional(z.string()),
+	status: z.nullable(z.string()),
+	total: z.number(),
+	subtotal: z.number(),
+	currency: z.string(),
+	/** Epoch seconds. */
+	created: z.number(),
+	hosted_invoice_url: z.optional(z.nullable(z.string()))
+});
+/** Stripe payment method. */
+const stripePaymentMethodSchema = z.looseObject({
+	id: z.string(),
+	type: z.string(),
+	card: z.optional(z.nullable(z.looseObject({
+		brand: z.string(),
+		last4: z.string(),
+		exp_month: z.optional(z.number()),
+		exp_year: z.optional(z.number())
+	})))
+});
+/** Price of each Stripe price id, after the promo code. */
+const pricingResultSchema = z.record(z.string(), z.object({
+	originalTotal: z.number(),
+	discountApplied: z.number(),
+	discountType: z.nullable(z.enum(["amount", "percentage"])),
+	finalTotal: z.number(),
+	currency: z.string(),
+	planType: z.enum([
+		"premium",
+		"enterprise",
+		"one_time",
+		"unknown"
+	]),
+	period: z.enum([
+		"monthly",
+		"yearly",
+		"one_time",
+		"unknown"
+	])
+}));
+const commissionTypeSchema = z.enum(["recurring", "one_time"]);
+/** Affiliate program member. The Stripe account id is admin information. */
+const affiliateSchema = z.looseObject({
+	id: z.string(),
+	userId: z.string(),
+	stripeAccountId: z.optional(z.string()),
+	stripeAccountType: z.optional(z.enum(["express", "standard"])),
+	referralCode: z.string(),
+	status: z.enum([
+		"pending",
+		"onboarding",
+		"active",
+		"suspended"
+	]),
+	/** Percentage (20 = 20%). */
+	commissionRate: z.number(),
+	commissionType: commissionTypeSchema,
+	chargesEnabled: z.optional(z.boolean()),
+	payoutsEnabled: z.optional(z.boolean()),
+	activatedAt: z.optional(dateTimeSchema),
+	stripeOnboardingInitiated: z.optional(z.boolean()),
+	createdAt: dateTimeSchema,
+	updatedAt: dateTimeSchema
+});
+const affiliateStatsSchema = z.object({
+	affiliate: affiliateSchema,
+	totalReferrals: z.number(),
+	convertedReferrals: z.number(),
+	pendingReferrals: z.number(),
+	/** In cents. */
+	totalCommissionEarned: z.number(),
+	/** In cents. */
+	pendingCommission: z.number(),
+	referralLink: z.string()
+});
+const affiliateInvitationSchema = z.looseObject({
+	id: z.string(),
+	email: z.string(),
+	token: z.string(),
+	status: z.enum([
+		"pending",
+		"accepted",
+		"expired"
+	]),
+	invitedBy: z.string(),
+	commissionRate: z.number(),
+	commissionType: commissionTypeSchema,
+	country: z.optional(z.string()),
+	expiresAt: dateTimeSchema,
+	createdAt: dateTimeSchema,
+	updatedAt: dateTimeSchema
+});
+const promoCodeSchema = z.looseObject({
+	id: z.string(),
+	code: z.string(),
+	stripeCouponId: z.string(),
+	stripePromotionCodeId: z.optional(z.string()),
+	affiliateId: z.optional(z.string()),
+	discountType: z.enum(["percentage", "amount"]),
+	discountValue: z.number(),
+	currency: z.optional(z.string()),
+	maxRedemptions: z.optional(z.number()),
+	timesRedeemed: z.number(),
+	active: z.boolean(),
+	expiresAt: z.optional(dateTimeSchema),
+	createdAt: dateTimeSchema,
+	updatedAt: dateTimeSchema
+});
+const idParamsSchema = z.object({ id: objectIdSchema });
+const tokenParamsSchema = z.object({ token: z.string().check(z.minLength(1)) });
+const searchQuerySchema = z.looseObject({
+	...paginationQueryShape,
+	search: z.optional(z.string())
+});
+const affiliateTermsShape = {
+	commissionRate: z.optional(z.number()),
+	commissionType: z.optional(commissionTypeSchema),
+	country: z.optional(z.string())
+};
+const affiliateResponseSchema = responseDataSchema(affiliateSchema);
+const promoCodeResponseSchema = responseDataSchema(promoCodeSchema);
+const urlResponseSchema = responseDataSchema(z.object({ url: z.string() }));
+/** REST contract of the `/api/stripe` routes (billing, affiliates, promo codes). */
+const stripeContract = defineRouteGroup({
+	prefix: "/api/stripe",
+	tag: "Billing",
+	routes: {
+		getPricing: defineRoute({
+			method: "POST",
+			path: "/pricing",
+			summary: "Prices of the plans, with an optional promo code",
+			schemas: {
+				body: z.object({
+					priceIds: z.optional(z.array(z.string())),
+					promoCode: z.optional(z.string())
+				}),
+				response: { 200: responseDataSchema(pricingResultSchema) }
+			}
+		}),
+		createSubscription: defineRoute({
+			method: "POST",
+			path: "/create-subscription",
+			summary: "Start a subscription checkout for the selected organization",
+			schemas: {
+				body: z.object({
+					priceId: z.string(),
+					promoCode: z.optional(z.string()),
+					referralCode: z.optional(z.string())
+				}),
+				response: { 200: responseDataSchema(z.looseObject({
+					/** Stripe subscription (one-time prices return a payment intent). */
+					subscription: z.optional(z.looseObject({ id: z.string() })),
+					paymentIntent: z.optional(z.looseObject({ id: z.string() })),
+					clientSecret: z.string()
+				})) }
+			}
+		}),
+		cancelSubscription: defineRoute({
+			method: "POST",
+			path: "/cancel-subscription",
+			summary: "Cancel the subscription of the selected organization",
+			schemas: { response: { 200: responseDataSchema(z.optional(planSchema)) } }
+		}),
+		getInvoices: defineRoute({
+			method: "GET",
+			path: "/invoices",
+			summary: "Invoices of the selected organization",
+			schemas: { response: { 200: responseDataSchema(z.array(stripeInvoiceSchema)) } }
+		}),
+		getPaymentMethod: defineRoute({
+			method: "GET",
+			path: "/payment-method",
+			summary: "Default payment method of the selected organization",
+			schemas: { response: { 200: responseDataSchema(z.nullable(stripePaymentMethodSchema)) } }
+		}),
+		createPortalSession: defineRoute({
+			method: "POST",
+			path: "/portal-session",
+			summary: "Stripe customer portal URL",
+			schemas: { response: { 200: urlResponseSchema } }
+		}),
+		grantAffiliateAccess: defineRoute({
+			method: "POST",
+			path: "/affiliate/grant",
+			summary: "Admin only: make a user an affiliate",
+			schemas: {
+				body: z.object({
+					userId: objectIdSchema,
+					...affiliateTermsShape
+				}),
+				response: { 200: affiliateResponseSchema }
+			}
+		}),
+		getAffiliates: defineRoute({
+			method: "GET",
+			path: "/affiliates",
+			summary: "Admin only: list affiliates",
+			schemas: {
+				querystring: searchQuerySchema,
+				response: { 200: paginatedResponseSchema(affiliateSchema) }
+			}
+		}),
+		getAffiliateById: defineRoute({
+			method: "GET",
+			path: "/affiliates/:id",
+			summary: "Admin only: get an affiliate",
+			schemas: {
+				params: idParamsSchema,
+				response: { 200: responseDataSchema(z.nullable(affiliateSchema)) }
+			}
+		}),
+		getAffiliate: defineRoute({
+			method: "GET",
+			path: "/affiliate",
+			summary: "Affiliate account of the signed-in user",
+			schemas: { response: { 200: responseDataSchema(z.nullable(affiliateSchema)) } }
+		}),
+		getAffiliateAccountSession: defineRoute({
+			method: "POST",
+			path: "/affiliate/account-session",
+			summary: "Stripe Connect embedded component session",
+			schemas: { response: { 200: responseDataSchema(z.object({ clientSecret: z.string() })) } }
+		}),
+		getAffiliateOnboardingLink: defineRoute({
+			method: "GET",
+			path: "/affiliate/onboarding-link",
+			summary: "Stripe Connect onboarding link",
+			schemas: {
+				querystring: z.object({ returnUrl: z.optional(z.string()) }),
+				response: { 200: urlResponseSchema }
+			}
+		}),
+		getAffiliateStats: defineRoute({
+			method: "GET",
+			path: "/affiliate/stats",
+			summary: "Referral and commission stats of the signed-in affiliate",
+			schemas: { response: { 200: responseDataSchema(z.nullable(affiliateStatsSchema)) } }
+		}),
+		getAffiliateInvitations: defineRoute({
+			method: "GET",
+			path: "/affiliate/invitations",
+			summary: "Admin only: list affiliate invitations",
+			schemas: {
+				querystring: searchQuerySchema,
+				response: { 200: paginatedResponseSchema(affiliateInvitationSchema) }
+			}
+		}),
+		sendAffiliateInvitation: defineRoute({
+			method: "POST",
+			path: "/affiliate/invite",
+			summary: "Admin only: invite someone to the affiliate program",
+			schemas: {
+				body: z.object({
+					email: z.string(),
+					...affiliateTermsShape
+				}),
+				response: { 200: responseDataSchema(z.object({ sent: z.boolean() })) }
+			}
+		}),
+		getAffiliateInvitation: defineRoute({
+			method: "GET",
+			path: "/affiliate/invitation/:token",
+			summary: "Invitation details (landing page of the invitation link)",
+			schemas: {
+				params: tokenParamsSchema,
+				response: { 200: responseDataSchema(z.nullable(affiliateInvitationSchema)) }
+			}
+		}),
+		acceptAffiliateInvitation: defineRoute({
+			method: "POST",
+			path: "/affiliate/invitation/:token/accept",
+			summary: "Accept an affiliate invitation",
+			schemas: {
+				params: tokenParamsSchema,
+				body: z.optional(z.object({
+					country: z.optional(z.string()),
+					stripeAccountType: z.optional(z.enum(["express", "standard"]))
+				})),
+				response: { 200: affiliateResponseSchema }
+			}
+		}),
+		updateAffiliateStatus: defineRoute({
+			method: "PATCH",
+			path: "/affiliates/:id/status",
+			summary: "Admin only: activate or suspend an affiliate",
+			schemas: {
+				params: idParamsSchema,
+				body: z.object({ status: z.optional(z.enum(["active", "suspended"])) }),
+				response: { 200: affiliateResponseSchema }
+			}
+		}),
+		getPromoCodes: defineRoute({
+			method: "GET",
+			path: "/promo-codes",
+			summary: "Admin only: list promo codes",
+			schemas: {
+				querystring: z.looseObject({
+					...searchQuerySchema.shape,
+					affiliateId: z.optional(z.string())
+				}),
+				response: { 200: paginatedResponseSchema(promoCodeSchema) }
+			}
+		}),
+		getPromoCodeById: defineRoute({
+			method: "GET",
+			path: "/promo-codes/:id",
+			summary: "Admin only: get a promo code",
+			schemas: {
+				params: idParamsSchema,
+				response: { 200: promoCodeResponseSchema }
+			}
+		}),
+		createPromoCode: defineRoute({
+			method: "POST",
+			path: "/promo-codes",
+			summary: "Admin only: create a promo code (and its Stripe coupon)",
+			schemas: {
+				body: z.object({
+					code: z.string().check(z.minLength(1)),
+					discountType: z.enum(["percentage", "amount"]),
+					discountValue: z.number(),
+					currency: z.optional(z.string()),
+					affiliateId: z.optional(z.string()),
+					maxRedemptions: z.optional(z.number()),
+					/** ISO date. */
+					expiresAt: z.optional(z.string())
+				}),
+				response: { 200: promoCodeResponseSchema }
+			}
+		}),
+		updatePromoCode: defineRoute({
+			method: "PATCH",
+			path: "/promo-codes/:id",
+			summary: "Admin only: update a promo code",
+			schemas: {
+				params: idParamsSchema,
+				body: z.object({
+					affiliateId: z.optional(z.nullable(z.string())),
+					active: z.optional(z.boolean()),
+					maxRedemptions: z.optional(z.number()),
+					/** ISO date. */
+					expiresAt: z.optional(z.string())
+				}),
+				response: { 200: promoCodeResponseSchema }
+			}
+		}),
+		deletePromoCode: defineRoute({
+			method: "DELETE",
+			path: "/promo-codes/:id",
+			summary: "Admin only: delete a promo code",
+			schemas: {
+				params: idParamsSchema,
+				response: { 200: responseDataSchema(z.object({ deleted: z.boolean() })) }
+			}
+		}),
+		getAffiliatePromoCode: defineRoute({
+			method: "GET",
+			path: "/affiliate-promo-code/:referralCode",
+			summary: "Promo code attached to a referral code (checkout)",
+			schemas: {
+				params: z.object({ referralCode: z.string().check(z.minLength(1)) }),
+				response: { 200: responseDataSchema(z.nullable(promoCodeSchema)) }
+			}
+		})
+	}
+});
+
+//#endregion
+export { affiliateInvitationSchema, affiliateSchema, affiliateStatsSchema, commissionTypeSchema, pricingResultSchema, promoCodeSchema, stripeContract, stripeInvoiceSchema, stripePaymentMethodSchema };
+//# sourceMappingURL=stripe.mjs.map

package/dist/esm/stripe.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe.mjs","names":[],"sources":["../../src/stripe.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport { dateTimeSchema, objectIdSchema, paginationQueryShape } from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n  type RouteQuerystring,\n} from './defineRoute';\nimport { type PlanAPI, planSchema } from './organization';\nimport {\n  type PaginatedResponse,\n  paginatedResponseSchema,\n  type ResponseData,\n  responseDataSchema,\n} from './responseData';\n\n// ── Stripe objects (subset of the Stripe API the dashboard reads) ───────────\n\n/** Stripe invoice. */\nexport const stripeInvoiceSchema = z.looseObject({\n  id: z.optional(z.string()),\n  status: z.nullable(z.string()),\n  total: z.number(),\n  subtotal: z.number(),\n  currency: z.string(),\n  /** Epoch seconds. */\n  created: z.number(),\n  hosted_invoice_url: z.optional(z.nullable(z.string())),\n});\n\n/** Stripe payment method. */\nexport const stripePaymentMethodSchema = z.looseObject({\n  id: z.string(),\n  type: z.string(),\n  card: z.optional(\n    z.nullable(\n      z.looseObject({\n        brand: z.string(),\n        last4: z.string(),\n        exp_month: z.optional(z.number()),\n        exp_year: z.optional(z.number()),\n      })\n    )\n  ),\n});\n\n/** Price of each Stripe price id, after the promo code. */\nexport const pricingResultSchema = z.record(\n  z.string(),\n  z.object({\n    originalTotal: z.number(),\n    discountApplied: z.number(),\n    discountType: z.nullable(z.enum(['amount', 'percentage'])),\n    finalTotal: z.number(),\n    currency: z.string(),\n    planType: z.enum(['premium', 'enterprise', 'one_time', 'unknown']),\n    period: z.enum(['monthly', 'yearly', 'one_time', 'unknown']),\n  })\n);\n\n// ── Affiliates ──────────────────────────────────────────────────────────────\n\nexport const commissionTypeSchema = z.enum(['recurring', 'one_time']);\n\n/** Affiliate program member. The Stripe account id is admin information. */\nexport const affiliateSchema = z.looseObject({\n  id: z.string(),\n  userId: z.string(),\n  stripeAccountId: z.optional(z.string()),\n  stripeAccountType: z.optional(z.enum(['express', 'standard'])),\n  referralCode: z.string(),\n  status: z.enum(['pending', 'onboarding', 'active', 'suspended']),\n  /** Percentage (20 = 20%). */\n  commissionRate: z.number(),\n  commissionType: commissionTypeSchema,\n  chargesEnabled: z.optional(z.boolean()),\n  payoutsEnabled: z.optional(z.boolean()),\n  activatedAt: z.optional(dateTimeSchema),\n  stripeOnboardingInitiated: z.optional(z.boolean()),\n  createdAt: dateTimeSchema,\n  updatedAt: dateTimeSchema,\n});\n\nexport const affiliateStatsSchema = z.object({\n  affiliate: affiliateSchema,\n  totalReferrals: z.number(),\n  convertedReferrals: z.number(),\n  pendingReferrals: z.number(),\n  /** In cents. */\n  totalCommissionEarned: z.number(),\n  /** In cents. */\n  pendingCommission: z.number(),\n  referralLink: z.string(),\n});\n\nexport const affiliateInvitationSchema = z.looseObject({\n  id: z.string(),\n  email: z.string(),\n  token: z.string(),\n  status: z.enum(['pending', 'accepted', 'expired']),\n  invitedBy: z.string(),\n  commissionRate: z.number(),\n  commissionType: commissionTypeSchema,\n  country: z.optional(z.string()),\n  expiresAt: dateTimeSchema,\n  createdAt: dateTimeSchema,\n  updatedAt: dateTimeSchema,\n});\n\n// ── Promo codes ─────────────────────────────────────────────────────────────\n\nexport const promoCodeSchema = z.looseObject({\n  id: z.string(),\n  code: z.string(),\n  stripeCouponId: z.string(),\n  stripePromotionCodeId: z.optional(z.string()),\n  affiliateId: z.optional(z.string()),\n  discountType: z.enum(['percentage', 'amount']),\n  discountValue: z.number(),\n  currency: z.optional(z.string()),\n  maxRedemptions: z.optional(z.number()),\n  timesRedeemed: z.number(),\n  active: z.boolean(),\n  expiresAt: z.optional(dateTimeSchema),\n  createdAt: dateTimeSchema,\n  updatedAt: dateTimeSchema,\n});\n\nconst idParamsSchema = z.object({ id: objectIdSchema });\nconst tokenParamsSchema = z.object({ token: z.string().check(z.minLength(1)) });\nconst searchQuerySchema = z.looseObject({\n  ...paginationQueryShape,\n  search: z.optional(z.string()),\n});\nconst affiliateTermsShape = {\n  commissionRate: z.optional(z.number()),\n  commissionType: z.optional(commissionTypeSchema),\n  country: z.optional(z.string()),\n};\nconst affiliateResponseSchema = responseDataSchema(affiliateSchema);\nconst promoCodeResponseSchema = responseDataSchema(promoCodeSchema);\nconst urlResponseSchema = responseDataSchema(z.object({ url: z.string() }));\n\n/** REST contract of the `/api/stripe` routes (billing, affiliates, promo codes). */\nexport const stripeContract = defineRouteGroup({\n  prefix: '/api/stripe',\n  tag: 'Billing',\n  routes: {\n    getPricing: defineRoute({\n      method: 'POST',\n      path: '/pricing',\n      summary: 'Prices of the plans, with an optional promo code',\n      schemas: {\n        body: z.object({\n          priceIds: z.optional(z.array(z.string())),\n          promoCode: z.optional(z.string()),\n        }),\n        response: { 200: responseDataSchema(pricingResultSchema) },\n      },\n    }),\n    createSubscription: defineRoute({\n      method: 'POST',\n      path: '/create-subscription',\n      summary: 'Start a subscription checkout for the selected organization',\n      schemas: {\n        body: z.object({\n          priceId: z.string(),\n          promoCode: z.optional(z.string()),\n          referralCode: z.optional(z.string()),\n        }),\n        response: {\n          200: responseDataSchema(\n            z.looseObject({\n              /** Stripe subscription (one-time prices return a payment intent). */\n              subscription: z.optional(z.looseObject({ id: z.string() })),\n              paymentIntent: z.optional(z.looseObject({ id: z.string() })),\n              clientSecret: z.string(),\n            })\n          ),\n        },\n      },\n    }),\n    cancelSubscription: defineRoute({\n      method: 'POST',\n      path: '/cancel-subscription',\n      summary: 'Cancel the subscription of the selected organization',\n      schemas: {\n        response: { 200: responseDataSchema(z.optional(planSchema)) },\n      },\n    }),\n    getInvoices: defineRoute({\n      method: 'GET',\n      path: '/invoices',\n      summary: 'Invoices of the selected organization',\n      schemas: {\n        response: { 200: responseDataSchema(z.array(stripeInvoiceSchema)) },\n      },\n    }),\n    getPaymentMethod: defineRoute({\n      method: 'GET',\n      path: '/payment-method',\n      summary: 'Default payment method of the selected organization',\n      schemas: {\n        response: {\n          200: responseDataSchema(z.nullable(stripePaymentMethodSchema)),\n        },\n      },\n    }),\n    createPortalSession: defineRoute({\n      method: 'POST',\n      path: '/portal-session',\n      summary: 'Stripe customer portal URL',\n      schemas: { response: { 200: urlResponseSchema } },\n    }),\n    grantAffiliateAccess: defineRoute({\n      method: 'POST',\n      path: '/affiliate/grant',\n      summary: 'Admin only: make a user an affiliate',\n      schemas: {\n        body: z.object({ userId: objectIdSchema, ...affiliateTermsShape }),\n        response: { 200: affiliateResponseSchema },\n      },\n    }),\n    getAffiliates: defineRoute({\n      method: 'GET',\n      path: '/affiliates',\n      summary: 'Admin only: list affiliates',\n      schemas: {\n        querystring: searchQuerySchema,\n        response: { 200: paginatedResponseSchema(affiliateSchema) },\n      },\n    }),\n    getAffiliateById: defineRoute({\n      method: 'GET',\n      path: '/affiliates/:id',\n      summary: 'Admin only: get an affiliate',\n      schemas: {\n        params: idParamsSchema,\n        response: { 200: responseDataSchema(z.nullable(affiliateSchema)) },\n      },\n    }),\n    getAffiliate: defineRoute({\n      method: 'GET',\n      path: '/affiliate',\n      summary: 'Affiliate account of the signed-in user',\n      schemas: {\n        response: { 200: responseDataSchema(z.nullable(affiliateSchema)) },\n      },\n    }),\n    getAffiliateAccountSession: defineRoute({\n      method: 'POST',\n      path: '/affiliate/account-session',\n      summary: 'Stripe Connect embedded component session',\n      schemas: {\n        response: {\n          200: responseDataSchema(z.object({ clientSecret: z.string() })),\n        },\n      },\n    }),\n    getAffiliateOnboardingLink: defineRoute({\n      method: 'GET',\n      path: '/affiliate/onboarding-link',\n      summary: 'Stripe Connect onboarding link',\n      schemas: {\n        querystring: z.object({ returnUrl: z.optional(z.string()) }),\n        response: { 200: urlResponseSchema },\n      },\n    }),\n    getAffiliateStats: defineRoute({\n      method: 'GET',\n      path: '/affiliate/stats',\n      summary: 'Referral and commission stats of the signed-in affiliate',\n      schemas: {\n        response: { 200: responseDataSchema(z.nullable(affiliateStatsSchema)) },\n      },\n    }),\n    getAffiliateInvitations: defineRoute({\n      method: 'GET',\n      path: '/affiliate/invitations',\n      summary: 'Admin only: list affiliate invitations',\n      schemas: {\n        querystring: searchQuerySchema,\n        response: { 200: paginatedResponseSchema(affiliateInvitationSchema) },\n      },\n    }),\n    sendAffiliateInvitation: defineRoute({\n      method: 'POST',\n      path: '/affiliate/invite',\n      summary: 'Admin only: invite someone to the affiliate program',\n      schemas: {\n        body: z.object({ email: z.string(), ...affiliateTermsShape }),\n        response: {\n          200: responseDataSchema(z.object({ sent: z.boolean() })),\n        },\n      },\n    }),\n    getAffiliateInvitation: defineRoute({\n      method: 'GET',\n      path: '/affiliate/invitation/:token',\n      summary: 'Invitation details (landing page of the invitation link)',\n      schemas: {\n        params: tokenParamsSchema,\n        response: {\n          200: responseDataSchema(z.nullable(affiliateInvitationSchema)),\n        },\n      },\n    }),\n    acceptAffiliateInvitation: defineRoute({\n      method: 'POST',\n      path: '/affiliate/invitation/:token/accept',\n      summary: 'Accept an affiliate invitation',\n      schemas: {\n        params: tokenParamsSchema,\n        body: z.optional(\n          z.object({\n            country: z.optional(z.string()),\n            stripeAccountType: z.optional(z.enum(['express', 'standard'])),\n          })\n        ),\n        response: { 200: affiliateResponseSchema },\n      },\n    }),\n    updateAffiliateStatus: defineRoute({\n      method: 'PATCH',\n      path: '/affiliates/:id/status',\n      summary: 'Admin only: activate or suspend an affiliate',\n      schemas: {\n        params: idParamsSchema,\n        body: z.object({\n          status: z.optional(z.enum(['active', 'suspended'])),\n        }),\n        response: { 200: affiliateResponseSchema },\n      },\n    }),\n    getPromoCodes: defineRoute({\n      method: 'GET',\n      path: '/promo-codes',\n      summary: 'Admin only: list promo codes',\n      schemas: {\n        querystring: z.looseObject({\n          ...searchQuerySchema.shape,\n          affiliateId: z.optional(z.string()),\n        }),\n        response: { 200: paginatedResponseSchema(promoCodeSchema) },\n      },\n    }),\n    getPromoCodeById: defineRoute({\n      method: 'GET',\n      path: '/promo-codes/:id',\n      summary: 'Admin only: get a promo code',\n      schemas: {\n        params: idParamsSchema,\n        response: { 200: promoCodeResponseSchema },\n      },\n    }),\n    createPromoCode: defineRoute({\n      method: 'POST',\n      path: '/promo-codes',\n      summary: 'Admin only: create a promo code (and its Stripe coupon)',\n      schemas: {\n        body: z.object({\n          code: z.string().check(z.minLength(1)),\n          discountType: z.enum(['percentage', 'amount']),\n          discountValue: z.number(),\n          currency: z.optional(z.string()),\n          affiliateId: z.optional(z.string()),\n          maxRedemptions: z.optional(z.number()),\n          /** ISO date. */\n          expiresAt: z.optional(z.string()),\n        }),\n        response: { 200: promoCodeResponseSchema },\n      },\n    }),\n    updatePromoCode: defineRoute({\n      method: 'PATCH',\n      path: '/promo-codes/:id',\n      summary: 'Admin only: update a promo code',\n      schemas: {\n        params: idParamsSchema,\n        body: z.object({\n          affiliateId: z.optional(z.nullable(z.string())),\n          active: z.optional(z.boolean()),\n          maxRedemptions: z.optional(z.number()),\n          /** ISO date. */\n          expiresAt: z.optional(z.string()),\n        }),\n        response: { 200: promoCodeResponseSchema },\n      },\n    }),\n    deletePromoCode: defineRoute({\n      method: 'DELETE',\n      path: '/promo-codes/:id',\n      summary: 'Admin only: delete a promo code',\n      schemas: {\n        params: idParamsSchema,\n        response: {\n          200: responseDataSchema(z.object({ deleted: z.boolean() })),\n        },\n      },\n    }),\n    getAffiliatePromoCode: defineRoute({\n      method: 'GET',\n      path: '/affiliate-promo-code/:referralCode',\n      summary: 'Promo code attached to a referral code (checkout)',\n      schemas: {\n        params: z.object({ referralCode: z.string().check(z.minLength(1)) }),\n        response: { 200: responseDataSchema(z.nullable(promoCodeSchema)) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/stripe` group, by name. */\nexport type StripeRoutes = (typeof stripeContract)['routes'];\n\nexport type StripeInvoice = z.output<typeof stripeInvoiceSchema>;\nexport type StripePaymentMethod = z.output<typeof stripePaymentMethodSchema>;\nexport type PricingResult = z.output<typeof pricingResultSchema>;\nexport type CommissionType = z.output<typeof commissionTypeSchema>;\nexport type AffiliateAPI = z.output<typeof affiliateSchema>;\nexport type AffiliateStats = z.output<typeof affiliateStatsSchema>;\nexport type AffiliateInvitationAPI = z.output<typeof affiliateInvitationSchema>;\nexport type PromoCodeAPI = z.output<typeof promoCodeSchema>;\n\nexport type GetPricingBody = RouteBodyInput<StripeRoutes['getPricing']>;\nexport type GetPricingResult = ResponseData<PricingResult>;\nexport type GetCheckoutSessionBody = RouteBodyInput<\n  StripeRoutes['createSubscription']\n>;\nexport type GetCheckoutSessionResult = ResponseData<{\n  subscription?: { id: string; [key: string]: unknown };\n  paymentIntent?: { id: string; [key: string]: unknown };\n  clientSecret: string;\n}>;\nexport type CancelSubscriptionResult = ResponseData<PlanAPI | undefined>;\nexport type GetInvoicesResult = ResponseData<StripeInvoice[]>;\nexport type GetPaymentMethodResult = ResponseData<StripePaymentMethod | null>;\nexport type CreatePortalSessionResult = ResponseData<{ url: string }>;\nexport type GrantAffiliateAccessBody = RouteBodyInput<\n  StripeRoutes['grantAffiliateAccess']\n>;\nexport type GrantAffiliateAccessResult = ResponseData<AffiliateAPI>;\nexport type GetAffiliatesParams = RouteQuerystring<\n  StripeRoutes['getAffiliates']\n>;\nexport type GetAffiliatesResult = PaginatedResponse<AffiliateAPI>;\nexport type GetAffiliateByIdResult = ResponseData<AffiliateAPI | null>;\nexport type GetAffiliateResult = ResponseData<AffiliateAPI | null>;\nexport type GetAffiliateAccountSessionResult = ResponseData<{\n  clientSecret: string;\n}>;\nexport type GetAffiliateOnboardingLinkResult = ResponseData<{ url: string }>;\nexport type GetAffiliateStatsResult = ResponseData<AffiliateStats | null>;\nexport type GetAffiliateInvitationsResult =\n  PaginatedResponse<AffiliateInvitationAPI>;\nexport type SendAffiliateInvitationBody = RouteBodyInput<\n  StripeRoutes['sendAffiliateInvitation']\n>;\nexport type SendAffiliateInvitationResult = ResponseData<{ sent: boolean }>;\nexport type GetAffiliateInvitationResult =\n  ResponseData<AffiliateInvitationAPI | null>;\nexport type UpdateAffiliateStatusBody = RouteBodyInput<\n  StripeRoutes['updateAffiliateStatus']\n>;\nexport type UpdateAffiliateStatusResult = ResponseData<AffiliateAPI>;\nexport type AcceptAffiliateInvitationBody = NonNullable<\n  RouteBodyInput<StripeRoutes['acceptAffiliateInvitation']>\n>;\nexport type AcceptAffiliateInvitationResult = ResponseData<AffiliateAPI>;\nexport type GetPromoCodesQuerystring = RouteQuerystring<\n  StripeRoutes['getPromoCodes']\n>;\nexport type GetPromoCodesResult = PaginatedResponse<PromoCodeAPI>;\nexport type GetPromoCodeByIdResult = ResponseData<PromoCodeAPI>;\nexport type CreatePromoCodeBody = RouteBodyInput<\n  StripeRoutes['createPromoCode']\n>;\nexport type CreatePromoCodeResult = ResponseData<PromoCodeAPI>;\nexport type UpdatePromoCodeBody = RouteBodyInput<\n  StripeRoutes['updatePromoCode']\n>;\nexport type UpdatePromoCodeResult = ResponseData<PromoCodeAPI>;\nexport type DeletePromoCodeResult = ResponseData<{ deleted: boolean }>;\n"],"mappings":";;;;;;;;AAmBA,MAAa,sBAAsB,EAAE,YAAY;CAC/C,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC;CACzB,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;CAC7B,OAAO,EAAE,OAAO;CAChB,UAAU,EAAE,OAAO;CACnB,UAAU,EAAE,OAAO;;CAEnB,SAAS,EAAE,OAAO;CAClB,oBAAoB,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;;AAGD,MAAa,4BAA4B,EAAE,YAAY;CACrD,IAAI,EAAE,OAAO;CACb,MAAM,EAAE,OAAO;CACf,MAAM,EAAE,SACN,EAAE,SACA,EAAE,YAAY;EACZ,OAAO,EAAE,OAAO;EAChB,OAAO,EAAE,OAAO;EAChB,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC;EAChC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC;CACjC,CAAC,CACH,CACF;AACF,CAAC;;AAGD,MAAa,sBAAsB,EAAE,OACnC,EAAE,OAAO,GACT,EAAE,OAAO;CACP,eAAe,EAAE,OAAO;CACxB,iBAAiB,EAAE,OAAO;CAC1B,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,UAAU,YAAY,CAAC,CAAC;CACzD,YAAY,EAAE,OAAO;CACrB,UAAU,EAAE,OAAO;CACnB,UAAU,EAAE,KAAK;EAAC;EAAW;EAAc;EAAY;CAAS,CAAC;CACjE,QAAQ,EAAE,KAAK;EAAC;EAAW;EAAU;EAAY;CAAS,CAAC;AAC7D,CAAC,CACH;AAIA,MAAa,uBAAuB,EAAE,KAAK,CAAC,aAAa,UAAU,CAAC;;AAGpE,MAAa,kBAAkB,EAAE,YAAY;CAC3C,IAAI,EAAE,OAAO;CACb,QAAQ,EAAE,OAAO;CACjB,iBAAiB,EAAE,SAAS,EAAE,OAAO,CAAC;CACtC,mBAAmB,EAAE,SAAS,EAAE,KAAK,CAAC,WAAW,UAAU,CAAC,CAAC;CAC7D,cAAc,EAAE,OAAO;CACvB,QAAQ,EAAE,KAAK;EAAC;EAAW;EAAc;EAAU;CAAW,CAAC;;CAE/D,gBAAgB,EAAE,OAAO;CACzB,gBAAgB;CAChB,gBAAgB,EAAE,SAAS,EAAE,QAAQ,CAAC;CACtC,gBAAgB,EAAE,SAAS,EAAE,QAAQ,CAAC;CACtC,aAAa,EAAE,SAAS,cAAc;CACtC,2BAA2B,EAAE,SAAS,EAAE,QAAQ,CAAC;CACjD,WAAW;CACX,WAAW;AACb,CAAC;AAED,MAAa,uBAAuB,EAAE,OAAO;CAC3C,WAAW;CACX,gBAAgB,EAAE,OAAO;CACzB,oBAAoB,EAAE,OAAO;CAC7B,kBAAkB,EAAE,OAAO;;CAE3B,uBAAuB,EAAE,OAAO;;CAEhC,mBAAmB,EAAE,OAAO;CAC5B,cAAc,EAAE,OAAO;AACzB,CAAC;AAED,MAAa,4BAA4B,EAAE,YAAY;CACrD,IAAI,EAAE,OAAO;CACb,OAAO,EAAE,OAAO;CAChB,OAAO,EAAE,OAAO;CAChB,QAAQ,EAAE,KAAK;EAAC;EAAW;EAAY;CAAS,CAAC;CACjD,WAAW,EAAE,OAAO;CACpB,gBAAgB,EAAE,OAAO;CACzB,gBAAgB;CAChB,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC;CAC9B,WAAW;CACX,WAAW;CACX,WAAW;AACb,CAAC;AAID,MAAa,kBAAkB,EAAE,YAAY;CAC3C,IAAI,EAAE,OAAO;CACb,MAAM,EAAE,OAAO;CACf,gBAAgB,EAAE,OAAO;CACzB,uBAAuB,EAAE,SAAS,EAAE,OAAO,CAAC;CAC5C,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC;CAClC,cAAc,EAAE,KAAK,CAAC,cAAc,QAAQ,CAAC;CAC7C,eAAe,EAAE,OAAO;CACxB,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC;CAC/B,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;CACrC,eAAe,EAAE,OAAO;CACxB,QAAQ,EAAE,QAAQ;CAClB,WAAW,EAAE,SAAS,cAAc;CACpC,WAAW;CACX,WAAW;AACb,CAAC;AAED,MAAM,iBAAiB,EAAE,OAAO,EAAE,IAAI,eAAe,CAAC;AACtD,MAAM,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;AAC9E,MAAM,oBAAoB,EAAE,YAAY;CACtC,GAAG;CACH,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;AAC/B,CAAC;AACD,MAAM,sBAAsB;CAC1B,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;CACrC,gBAAgB,EAAE,SAAS,oBAAoB;CAC/C,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC;AAChC;AACA,MAAM,0BAA0B,mBAAmB,eAAe;AAClE,MAAM,0BAA0B,mBAAmB,eAAe;AAClE,MAAM,oBAAoB,mBAAmB,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;;AAG1E,MAAa,iBAAiB,iBAAiB;CAC7C,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,YAAY,YAAY;GACtB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO;KACb,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;KACxC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC;IAClC,CAAC;IACD,UAAU,EAAE,KAAK,mBAAmB,mBAAmB,EAAE;GAC3D;EACF,CAAC;EACD,oBAAoB,YAAY;GAC9B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO;KACb,SAAS,EAAE,OAAO;KAClB,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC;KAChC,cAAc,EAAE,SAAS,EAAE,OAAO,CAAC;IACrC,CAAC;IACD,UAAU,EACR,KAAK,mBACH,EAAE,YAAY;;KAEZ,cAAc,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;KAC1D,eAAe,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;KAC3D,cAAc,EAAE,OAAO;IACzB,CAAC,CACH,EACF;GACF;EACF,CAAC;EACD,oBAAoB,YAAY;GAC9B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAK,mBAAmB,EAAE,SAAS,UAAU,CAAC,EAAE,EAC9D;EACF,CAAC;EACD,aAAa,YAAY;GACvB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC,EAAE,EACpE;EACF,CAAC;EACD,kBAAkB,YAAY;GAC5B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EACR,KAAK,mBAAmB,EAAE,SAAS,yBAAyB,CAAC,EAC/D,EACF;EACF,CAAC;EACD,qBAAqB,YAAY;GAC/B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EAAE,UAAU,EAAE,KAAK,kBAAkB,EAAE;EAClD,CAAC;EACD,sBAAsB,YAAY;GAChC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO;KAAE,QAAQ;KAAgB,GAAG;IAAoB,CAAC;IACjE,UAAU,EAAE,KAAK,wBAAwB;GAC3C;EACF,CAAC;EACD,eAAe,YAAY;GACzB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAa;IACb,UAAU,EAAE,KAAK,wBAAwB,eAAe,EAAE;GAC5D;EACF,CAAC;EACD,kBAAkB,YAAY;GAC5B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAK,mBAAmB,EAAE,SAAS,eAAe,CAAC,EAAE;GACnE;EACF,CAAC;EACD,cAAc,YAAY;GACxB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAK,mBAAmB,EAAE,SAAS,eAAe,CAAC,EAAE,EACnE;EACF,CAAC;EACD,4BAA4B,YAAY;GACtC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EACR,KAAK,mBAAmB,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC,EAChE,EACF;EACF,CAAC;EACD,4BAA4B,YAAY;GACtC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;IAC3D,UAAU,EAAE,KAAK,kBAAkB;GACrC;EACF,CAAC;EACD,mBAAmB,YAAY;GAC7B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAK,mBAAmB,EAAE,SAAS,oBAAoB,CAAC,EAAE,EACxE;EACF,CAAC;EACD,yBAAyB,YAAY;GACnC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAa;IACb,UAAU,EAAE,KAAK,wBAAwB,yBAAyB,EAAE;GACtE;EACF,CAAC;EACD,yBAAyB,YAAY;GACnC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO;KAAE,OAAO,EAAE,OAAO;KAAG,GAAG;IAAoB,CAAC;IAC5D,UAAU,EACR,KAAK,mBAAmB,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,EACzD;GACF;EACF,CAAC;EACD,wBAAwB,YAAY;GAClC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EACR,KAAK,mBAAmB,EAAE,SAAS,yBAAyB,CAAC,EAC/D;GACF;EACF,CAAC;EACD,2BAA2B,YAAY;GACrC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAM,EAAE,SACN,EAAE,OAAO;KACP,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC;KAC9B,mBAAmB,EAAE,SAAS,EAAE,KAAK,CAAC,WAAW,UAAU,CAAC,CAAC;IAC/D,CAAC,CACH;IACA,UAAU,EAAE,KAAK,wBAAwB;GAC3C;EACF,CAAC;EACD,uBAAuB,YAAY;GACjC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAM,EAAE,OAAO,EACb,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,UAAU,WAAW,CAAC,CAAC,EACpD,CAAC;IACD,UAAU,EAAE,KAAK,wBAAwB;GAC3C;EACF,CAAC;EACD,eAAe,YAAY;GACzB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAa,EAAE,YAAY;KACzB,GAAG,kBAAkB;KACrB,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC;IACpC,CAAC;IACD,UAAU,EAAE,KAAK,wBAAwB,eAAe,EAAE;GAC5D;EACF,CAAC;EACD,kBAAkB,YAAY;GAC5B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAK,wBAAwB;GAC3C;EACF,CAAC;EACD,iBAAiB,YAAY;GAC3B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO;KACb,MAAM,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;KACrC,cAAc,EAAE,KAAK,CAAC,cAAc,QAAQ,CAAC;KAC7C,eAAe,EAAE,OAAO;KACxB,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC;KAC/B,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC;KAClC,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;;KAErC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC;IAClC,CAAC;IACD,UAAU,EAAE,KAAK,wBAAwB;GAC3C;EACF,CAAC;EACD,iBAAiB,YAAY;GAC3B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAM,EAAE,OAAO;KACb,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;KAC9C,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;KAC9B,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;;KAErC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC;IAClC,CAAC;IACD,UAAU,EAAE,KAAK,wBAAwB;GAC3C;EACF,CAAC;EACD,iBAAiB,YAAY;GAC3B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EACR,KAAK,mBAAmB,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC,EAC5D;GACF;EACF,CAAC;EACD,uBAAuB,YAAY;GACjC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;IACnE,UAAU,EAAE,KAAK,mBAAmB,EAAE,SAAS,eAAe,CAAC,EAAE;GACnE;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/esm/tag.mjs

@@ -0,0 +1,81 @@
+import { defineRoute, defineRouteGroup } from "./defineRoute.mjs";
+import { paginatedResponseSchema, responseDataSchema } from "./responseData.mjs";
+import { dateTimeSchema, objectIdSchema, paginationQueryShape, repeatableQueryValueSchema } from "./common.mjs";
+import { z } from "zod/mini";
+
+//#region src/tag.ts
+/** Tag editable fields: ownership (project, organization, creator) is set by the server. */
+const tagFieldsShape = {
+	key: z.string().check(z.minLength(1)),
+	name: z.optional(z.string()),
+	description: z.optional(z.string()),
+	instructions: z.optional(z.string())
+};
+/** Tag as returned by the API. */
+const tagSchema = z.looseObject({
+	id: z.string(),
+	...tagFieldsShape,
+	creatorId: z.string(),
+	projectId: z.string(),
+	organizationId: z.string(),
+	createdAt: dateTimeSchema,
+	updatedAt: dateTimeSchema
+});
+const tagIdParamsSchema = z.object({ tagId: objectIdSchema });
+/** REST contract of the `/api/tag` routes. */
+const tagContract = defineRouteGroup({
+	prefix: "/api/tag",
+	tag: "Tag",
+	routes: {
+		getTags: defineRoute({
+			method: "GET",
+			path: "/",
+			summary: "List the tags of the selected project",
+			schemas: {
+				querystring: z.looseObject({
+					...paginationQueryShape,
+					ids: z.optional(repeatableQueryValueSchema),
+					keys: z.optional(repeatableQueryValueSchema),
+					name: z.optional(z.string()),
+					search: z.optional(z.string()),
+					organizationId: z.optional(z.string()),
+					/** Admin only: list tags of every organization. */
+					fetchAll: z.optional(z.enum(["true", "false"]))
+				}),
+				response: { 200: paginatedResponseSchema(tagSchema) }
+			}
+		}),
+		addTag: defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Create a tag in the selected project",
+			schemas: {
+				body: z.object(tagFieldsShape),
+				response: { 200: responseDataSchema(tagSchema) }
+			}
+		}),
+		updateTag: defineRoute({
+			method: "PUT",
+			path: "/:tagId",
+			summary: "Update a tag",
+			schemas: {
+				params: tagIdParamsSchema,
+				body: z.partial(z.object(tagFieldsShape)),
+				response: { 200: responseDataSchema(tagSchema) }
+			}
+		}),
+		deleteTag: defineRoute({
+			method: "DELETE",
+			path: "/:tagId",
+			summary: "Delete a tag",
+			schemas: {
+				params: tagIdParamsSchema,
+				response: { 200: responseDataSchema(tagSchema) }
+			}
+		})
+	}
+});
+
+//#endregion
+export { tagContract, tagSchema };
+//# sourceMappingURL=tag.mjs.map

package/dist/esm/tag.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag.mjs","names":[],"sources":["../../src/tag.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport {\n  dateTimeSchema,\n  objectIdSchema,\n  paginationQueryShape,\n  repeatableQueryValueSchema,\n} from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n  type RouteParams,\n  type RouteQuerystring,\n} from './defineRoute';\nimport {\n  type PaginatedResponse,\n  paginatedResponseSchema,\n  type ResponseData,\n  responseDataSchema,\n} from './responseData';\n\n/** Tag editable fields: ownership (project, organization, creator) is set by the server. */\nconst tagFieldsShape = {\n  key: z.string().check(z.minLength(1)),\n  name: z.optional(z.string()),\n  description: z.optional(z.string()),\n  instructions: z.optional(z.string()),\n};\n\n/** Tag as returned by the API. */\nexport const tagSchema = z.looseObject({\n  id: z.string(),\n  ...tagFieldsShape,\n  creatorId: z.string(),\n  projectId: z.string(),\n  organizationId: z.string(),\n  createdAt: dateTimeSchema,\n  updatedAt: dateTimeSchema,\n});\n\nconst tagIdParamsSchema = z.object({ tagId: objectIdSchema });\n\n/** REST contract of the `/api/tag` routes. */\nexport const tagContract = defineRouteGroup({\n  prefix: '/api/tag',\n  tag: 'Tag',\n  routes: {\n    getTags: defineRoute({\n      method: 'GET',\n      path: '/',\n      summary: 'List the tags of the selected project',\n      schemas: {\n        querystring: z.looseObject({\n          ...paginationQueryShape,\n          ids: z.optional(repeatableQueryValueSchema),\n          keys: z.optional(repeatableQueryValueSchema),\n          name: z.optional(z.string()),\n          search: z.optional(z.string()),\n          organizationId: z.optional(z.string()),\n          /** Admin only: list tags of every organization. */\n          fetchAll: z.optional(z.enum(['true', 'false'])),\n        }),\n        response: { 200: paginatedResponseSchema(tagSchema) },\n      },\n    }),\n    addTag: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Create a tag in the selected project',\n      schemas: {\n        body: z.object(tagFieldsShape),\n        response: { 200: responseDataSchema(tagSchema) },\n      },\n    }),\n    updateTag: defineRoute({\n      method: 'PUT',\n      path: '/:tagId',\n      summary: 'Update a tag',\n      schemas: {\n        params: tagIdParamsSchema,\n        body: z.partial(z.object(tagFieldsShape)),\n        response: { 200: responseDataSchema(tagSchema) },\n      },\n    }),\n    deleteTag: defineRoute({\n      method: 'DELETE',\n      path: '/:tagId',\n      summary: 'Delete a tag',\n      schemas: {\n        params: tagIdParamsSchema,\n        response: { 200: responseDataSchema(tagSchema) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/tag` group, by name. */\nexport type TagRoutes = (typeof tagContract)['routes'];\n\nexport type TagAPI = z.output<typeof tagSchema>;\nexport type GetTagsParams = RouteQuerystring<TagRoutes['getTags']>;\nexport type GetTagsResult = PaginatedResponse<TagAPI>;\nexport type AddTagBody = RouteBodyInput<TagRoutes['addTag']>;\nexport type AddTagResult = ResponseData<TagAPI>;\nexport type UpdateTagParams = RouteParams<TagRoutes['updateTag']>;\nexport type UpdateTagBody = RouteBodyInput<TagRoutes['updateTag']>;\nexport type UpdateTagResult = ResponseData<TagAPI>;\nexport type DeleteTagParams = RouteParams<TagRoutes['deleteTag']>;\nexport type DeleteTagResult = ResponseData<TagAPI>;\n"],"mappings":";;;;;;;AAsBA,MAAM,iBAAiB;CACrB,KAAK,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACpC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;CAC3B,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC;CAClC,cAAc,EAAE,SAAS,EAAE,OAAO,CAAC;AACrC;;AAGA,MAAa,YAAY,EAAE,YAAY;CACrC,IAAI,EAAE,OAAO;CACb,GAAG;CACH,WAAW,EAAE,OAAO;CACpB,WAAW,EAAE,OAAO;CACpB,gBAAgB,EAAE,OAAO;CACzB,WAAW;CACX,WAAW;AACb,CAAC;AAED,MAAM,oBAAoB,EAAE,OAAO,EAAE,OAAO,eAAe,CAAC;;AAG5D,MAAa,cAAc,iBAAiB;CAC1C,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,SAAS,YAAY;GACnB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAa,EAAE,YAAY;KACzB,GAAG;KACH,KAAK,EAAE,SAAS,0BAA0B;KAC1C,MAAM,EAAE,SAAS,0BAA0B;KAC3C,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;KAC3B,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;KAC7B,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;;KAErC,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,OAAO,CAAC,CAAC;IAChD,CAAC;IACD,UAAU,EAAE,KAAK,wBAAwB,SAAS,EAAE;GACtD;EACF,CAAC;EACD,QAAQ,YAAY;GAClB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO,cAAc;IAC7B,UAAU,EAAE,KAAK,mBAAmB,SAAS,EAAE;GACjD;EACF,CAAC;EACD,WAAW,YAAY;GACrB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAM,EAAE,QAAQ,EAAE,OAAO,cAAc,CAAC;IACxC,UAAU,EAAE,KAAK,mBAAmB,SAAS,EAAE;GACjD;EACF,CAAC;EACD,WAAW,YAAY;GACrB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAK,mBAAmB,SAAS,EAAE;GACjD;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/esm/translation.mjs

@@ -0,0 +1,53 @@
+import { defineRoute, defineRouteGroup } from "./defineRoute.mjs";
+import { responseDataSchema } from "./responseData.mjs";
+import { typedStringSchema } from "./common.mjs";
+import { z } from "zod/mini";
+
+//#region src/translation.ts
+const jobIdParamsSchema = z.object({ jobId: z.string().check(z.minLength(1)) });
+const jobResponseSchema = responseDataSchema(z.unknown());
+/** Job control routes share the same shape. */
+const jobRoute = (path, summary) => defineRoute({
+	method: "POST",
+	path,
+	summary,
+	schemas: {
+		params: jobIdParamsSchema,
+		response: { 200: jobResponseSchema }
+	}
+});
+/** REST contract of the live translation routes (Redis-backed queue). */
+const translationContract = defineRouteGroup({
+	prefix: "/api/translate",
+	tag: "Translation",
+	routes: {
+		translateDictionaries: defineRoute({
+			method: "POST",
+			path: "/dictionaries",
+			summary: "Queue the translation of dictionaries into locales",
+			schemas: {
+				body: z.object({
+					dictionaryIds: z.array(z.string()),
+					targetLocales: z.array(typedStringSchema()),
+					mode: z.optional(z.enum(["complete", "review"]))
+				}),
+				response: { 200: responseDataSchema(z.object({ jobId: z.string() })) }
+			}
+		}),
+		getTranslationStatus: defineRoute({
+			method: "GET",
+			path: "/status",
+			summary: "Translation job progress (server-sent events stream)",
+			schemas: {}
+		}),
+		pauseTranslationJob: jobRoute("/:jobId/pause", "Pause a translation job"),
+		resumeTranslationJob: jobRoute("/:jobId/resume", "Resume a paused translation job"),
+		stopTranslationJob: jobRoute("/:jobId/stop", "Stop a translation job"),
+		retryTranslationJob: jobRoute("/:jobId/retry", "Retry the failed items of a job"),
+		restartTranslationJob: jobRoute("/:jobId/restart", "Restart a translation job")
+	}
+});
+
+//#endregion
+export { translationContract };
+//# sourceMappingURL=translation.mjs.map

package/dist/esm/translation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation.mjs","names":[],"sources":["../../src/translation.ts"],"sourcesContent":["import type { Locale } from '@intlayer/types/allLocales';\nimport { z } from 'zod/mini';\nimport { typedStringSchema } from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n} from './defineRoute';\nimport { type ResponseData, responseDataSchema } from './responseData';\n\nconst jobIdParamsSchema = z.object({ jobId: z.string().check(z.minLength(1)) });\nconst jobResponseSchema = responseDataSchema(z.unknown());\n\n/** Job control routes share the same shape. */\nconst jobRoute = (path: `/:jobId/${string}`, summary: string) =>\n  defineRoute({\n    method: 'POST',\n    path,\n    summary,\n    schemas: {\n      params: jobIdParamsSchema,\n      response: { 200: jobResponseSchema },\n    },\n  });\n\n/** REST contract of the live translation routes (Redis-backed queue). */\nexport const translationContract = defineRouteGroup({\n  prefix: '/api/translate',\n  tag: 'Translation',\n  routes: {\n    translateDictionaries: defineRoute({\n      method: 'POST',\n      path: '/dictionaries',\n      summary: 'Queue the translation of dictionaries into locales',\n      schemas: {\n        body: z.object({\n          dictionaryIds: z.array(z.string()),\n          targetLocales: z.array(typedStringSchema<Locale>()),\n          mode: z.optional(z.enum(['complete', 'review'])),\n        }),\n        response: {\n          200: responseDataSchema(z.object({ jobId: z.string() })),\n        },\n      },\n    }),\n    getTranslationStatus: defineRoute({\n      method: 'GET',\n      path: '/status',\n      summary: 'Translation job progress (server-sent events stream)',\n      schemas: {},\n    }),\n    pauseTranslationJob: jobRoute('/:jobId/pause', 'Pause a translation job'),\n    resumeTranslationJob: jobRoute(\n      '/:jobId/resume',\n      'Resume a paused translation job'\n    ),\n    stopTranslationJob: jobRoute('/:jobId/stop', 'Stop a translation job'),\n    retryTranslationJob: jobRoute(\n      '/:jobId/retry',\n      'Retry the failed items of a job'\n    ),\n    restartTranslationJob: jobRoute(\n      '/:jobId/restart',\n      'Restart a translation job'\n    ),\n  },\n});\n\n/** Route definitions of the translation group, by name. */\nexport type TranslationRoutes = (typeof translationContract)['routes'];\n\nexport type TranslateDictionariesBody = RouteBodyInput<\n  TranslationRoutes['translateDictionaries']\n>;\nexport type TranslateDictionariesResult = ResponseData<{ jobId: string }>;\n"],"mappings":";;;;;;AAUA,MAAM,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;AAC9E,MAAM,oBAAoB,mBAAmB,EAAE,QAAQ,CAAC;;AAGxD,MAAM,YAAY,MAA2B,YAC3C,YAAY;CACV,QAAQ;CACR;CACA;CACA,SAAS;EACP,QAAQ;EACR,UAAU,EAAE,KAAK,kBAAkB;CACrC;AACF,CAAC;;AAGH,MAAa,sBAAsB,iBAAiB;CAClD,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,uBAAuB,YAAY;GACjC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO;KACb,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC;KACjC,eAAe,EAAE,MAAM,kBAA0B,CAAC;KAClD,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,YAAY,QAAQ,CAAC,CAAC;IACjD,CAAC;IACD,UAAU,EACR,KAAK,mBAAmB,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,EACzD;GACF;EACF,CAAC;EACD,sBAAsB,YAAY;GAChC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,CAAC;EACZ,CAAC;EACD,qBAAqB,SAAS,iBAAiB,yBAAyB;EACxE,sBAAsB,SACpB,kBACA,iCACF;EACA,oBAAoB,SAAS,gBAAgB,wBAAwB;EACrE,qBAAqB,SACnB,iBACA,iCACF;EACA,uBAAuB,SACrB,mBACA,2BACF;CACF;AACF,CAAC"}