feat: implement sysadmin subscription management and plan usage cycle recalculation tools

2026-07-18 21:32:47 -03:00
parent 1c8c47cf76
commit 4f3b56784e
36 changed files with 2146 additions and 21 deletions
@@ -0,0 +1,94 @@
+import { IPlanUsageCycleDocument } from "./PlanUsageCycle.Adapter.Mongoose";
+
+export interface IPlanUsageCycle {
+    id?: string;
+    userId: string;
+    subscriptionId?: string;
+    planId: string;
+    cycleStart: Date;
+    cycleEnd: Date;
+    appointmentsCount: number;
+    creationDate: Date;
+    updateDate: Date;
+}
+
+export type FindPlanUsageCycleParams = {
+    userId?: string;
+    subscriptionId?: string;
+    planId?: string;
+    cycleStart?: Date;
+    cycleEnd?: Date;
+};
+
+export type CreatePlanUsageCycleParams = {
+    userId: string;
+    subscriptionId?: string;
+    planId: string;
+    cycleStart: Date;
+    cycleEnd: Date;
+    appointmentsCount?: number;
+};
+
+export type CurrentPlanUsageCycleParams = {
+    userId: string;
+    now?: Date;
+    limit?: number;
+};
+
+export type SetPlanUsageCycleAppointmentsParams = CurrentPlanUsageCycleParams & {
+    appointmentsCount: number;
+};
+
+export type SysAdminRecalculatePlanUsageCycleParams = {
+    userId: string;
+};
+
+export type SysAdminRecalculatePlanUsageCycleResult = {
+    userId: string;
+    subscriptionId: string;
+    planId: string;
+    cycleStart: Date;
+    cycleEnd: Date;
+    appointmentsCount: number;
+};
+
+export type UpdatePlanUsageCycleParams = {
+    userId: string;
+    subscriptionId: string;
+    planId: string;
+    cycleStart: Date;
+    cycleEnd: Date;
+};
+
+export type CalculateCurrentCycleParams = {
+    subscriptionStartDate: Date;
+    now?: Date;
+};
+
+export type PlanUsageCycleRange = {
+    cycleStart: Date;
+    cycleEnd: Date;
+};
+
+export interface IPlanUsageCycleAdapter {
+    findOne(filters: FindPlanUsageCycleParams): Promise<IPlanUsageCycleDocument | null>;
+    create(data: CreatePlanUsageCycleParams): Promise<IPlanUsageCycleDocument>;
+    getOrCreateCurrent(data: UpdatePlanUsageCycleParams): Promise<IPlanUsageCycleDocument>;
+    incrementAppointments(data: UpdatePlanUsageCycleParams & { quantity: number }): Promise<IPlanUsageCycleDocument | null>;
+    incrementAppointmentsIfWithinLimit(
+        data: UpdatePlanUsageCycleParams & { quantity: number; limit: number }
+    ): Promise<IPlanUsageCycleDocument | null>;
+    setAppointmentsCount(
+        data: UpdatePlanUsageCycleParams & { appointmentsCount: number }
+    ): Promise<IPlanUsageCycleDocument | null>;
+}
+
+export interface IPlanUsageCycleManager {
+    planUsageCycle: IPlanUsageCycleAdapter;
+    getCurrentCycle(data: CurrentPlanUsageCycleParams): Promise<IPlanUsageCycleDocument>;
+    addAppointment(data: CurrentPlanUsageCycleParams & { quantity?: number }): Promise<void>;
+    reserveAppointment(data: CurrentPlanUsageCycleParams & { quantity?: number }): Promise<boolean>;
+    releaseAppointment(data: CurrentPlanUsageCycleParams & { quantity?: number }): Promise<void>;
+    getAppointmentsCount(data: CurrentPlanUsageCycleParams): Promise<number>;
+    setAppointmentsCount(data: SetPlanUsageCycleAppointmentsParams): Promise<IPlanUsageCycleDocument | null>;
+}