fix(billing): deduplicate schema fields and fix update JSDoc return type

Author: PierreBrisorgueil

modules/billing/models/billing.subscription.schema.js

@@ -8,48 +8,36 @@ import { z } from 'zod';
  */
 const objectIdRegex = /^[a-f\d]{24}$/i;
 
-const Subscription = z.object({
-  organization: z
-    .string()
-    .trim()
-    .regex(objectIdRegex, 'organization must be a valid ObjectId'),
-  stripeCustomerId: z
-    .string()
-    .trim()
-    .optional()
-    .transform((val) => (val === '' ? undefined : val)),
-  stripeSubscriptionId: z
-    .string()
-    .trim()
-    .optional()
-    .transform((val) => (val === '' ? undefined : val)),
-  plan: z.enum(['free', 'starter', 'pro']).default('free'),
-  status: z.enum(['active', 'past_due', 'canceled', 'trialing', 'incomplete']).default('active'),
+const optionalStripeId = z
+  .string()
+  .trim()
+  .optional()
+  .transform((val) => (val === '' ? undefined : val));
+
+const plans = ['free', 'starter', 'pro'];
+const statuses = ['active', 'past_due', 'canceled', 'trialing', 'incomplete'];
+
+const baseShape = {
+  organization: z.string().trim().regex(objectIdRegex, 'organization must be a valid ObjectId'),
+  stripeCustomerId: optionalStripeId,
+  stripeSubscriptionId: optionalStripeId,
   currentPeriodEnd: z.coerce.date().nullable().optional(),
+};
+
+const Subscription = z.object({
+  ...baseShape,
+  plan: z.enum(plans).default('free'),
+  status: z.enum(statuses).default('active'),
   cancelAtPeriodEnd: z.boolean().default(false),
 });
 
 /**
  * Update schema without defaults to avoid populating unspecified fields during PATCH
  */
 const SubscriptionCore = z.object({
-  organization: z
-    .string()
-    .trim()
-    .regex(objectIdRegex, 'organization must be a valid ObjectId'),
-  stripeCustomerId: z
-    .string()
-    .trim()
-    .optional()
-    .transform((val) => (val === '' ? undefined : val)),
-  stripeSubscriptionId: z
-    .string()
-    .trim()
-    .optional()
-    .transform((val) => (val === '' ? undefined : val)),
-  plan: z.enum(['free', 'starter', 'pro']),
-  status: z.enum(['active', 'past_due', 'canceled', 'trialing', 'incomplete']),
-  currentPeriodEnd: z.coerce.date().nullable().optional(),
+  ...baseShape,
+  plan: z.enum(plans),
+  status: z.enum(statuses),
   cancelAtPeriodEnd: z.boolean(),
 });
 

modules/billing/repositories/billing.subscription.repository.js

@@ -50,7 +50,7 @@ const get = (id) => {
  * @function update
  * @description Data access operation to update an existing subscription in the database.
  * @param {Object} subscription - The subscription object containing the updated details.
- * @returns {Promise<Object>} A promise resolving to the updated subscription.
+ * @returns {Promise<Object>|null} A promise resolving to the updated subscription, or null if the ID is invalid.
  */
 const update = (subscription) => {
   const id = resolveId(subscription);