@dalmore/api-contracts 1.0.5 → 1.0.6

package/src/common/types/dashboard.types.ts

@@ -0,0 +1,799 @@
+import { z } from 'zod';
+import { TaskZod } from './task.types';
+import { offeringIdSchema } from './offering.types';
+import {
+  dateSchema,
+  FileLabelsEnum,
+  FileLabels,
+  IPaginationMeta,
+  OfferingType,
+} from './common.types';
+import { accountIdSchema } from './account.types';
+
+export const DashboardIntervalsZod = z.object({
+  yesterdayCount: z.coerce.number().int().default(0),
+  lastWeekCount: z.coerce.number().int().default(0),
+  lastMonthCount: z.coerce.number().int().default(0),
+  totalCount: z.coerce.number().int().default(0),
+});
+export type DashboardIntervalsZod = z.infer<typeof DashboardIntervalsZod>;
+
+export const TradeIntervalsZod = z
+  .object({
+    yesterdaySum: z.coerce.number().default(0),
+    lastWeekSum: z.coerce.number().default(0),
+    lastMonthSum: z.coerce.number().default(0),
+    totalSum: z.coerce.number().default(0),
+  })
+  .and(DashboardIntervalsZod);
+export type TradeIntervalsZod = z.infer<typeof TradeIntervalsZod>;
+
+export const ActiveOfferingZod = z.object({
+  id: offeringIdSchema,
+  name: z.string(),
+  cart: z.coerce.number().int().default(0),
+  cartSum: z.coerce.number().default(0),
+  account: z.coerce.number().int().default(0),
+  accountSum: z.coerce.number().default(0),
+  payment: z.coerce.number().int().default(0),
+  paymentSum: z.coerce.number().default(0),
+  subdoc: z.coerce.number().int().default(0),
+  subdocSum: z.coerce.number().default(0),
+  placed: z.coerce.number().int().default(0),
+  placedSum: z.coerce.number().default(0),
+  review: z.coerce.number().int().default(0),
+  reviewSum: z.coerce.number().default(0),
+  funding: z.coerce.number().int().default(0),
+  fundingSum: z.coerce.number().default(0),
+  settled: z.coerce.number().int().default(0),
+  settledSum: z.coerce.number().default(0),
+});
+
+export type ActiveOfferingZod = z.infer<typeof ActiveOfferingZod>;
+
+export const ActiveOfferingTimelineZod = z
+  .object({
+    id: offeringIdSchema,
+    name: z.string(),
+  })
+  .and(DashboardIntervalsZod);
+export type ActiveOfferingTimelineZod = z.infer<
+  typeof ActiveOfferingTimelineZod
+>;
+
+export const ActiveOfferings = z.array(ActiveOfferingZod);
+export type ActiveOfferings = z.infer<typeof ActiveOfferings>;
+
+export const ActiveOfferingsTimeline = z.array(ActiveOfferingTimelineZod);
+export type ActiveOfferingsTimeline = z.infer<typeof ActiveOfferingsTimeline>;
+
+export const IssuerDashboardZod = z.object({
+  investors: DashboardIntervalsZod,
+  trades: TradeIntervalsZod,
+  activeOfferings: z.array(ActiveOfferingZod).nullable(),
+  activeOfferingsTimeline: z.array(ActiveOfferingTimelineZod).nullable(),
+  tasks: z.array(z.lazy(() => TaskZod)).nullable(),
+});
+export type IssuerDashboardZod = z.infer<typeof IssuerDashboardZod>;
+
+export const PastWeeklyTrade = z.object({
+  weekRange: z.string(),
+  total: z.coerce.number().default(0),
+  progressionSum: z.coerce.number().default(0),
+  weekCount: z.coerce.number().default(0),
+});
+export type PastWeeklyTrade = z.infer<typeof PastWeeklyTrade>;
+
+export const PastWeeklyTrades = z.array(PastWeeklyTrade);
+
+export type PastWeeklyTrades = z.infer<typeof PastWeeklyTrades>;
+
+export const TotalSettledTradesZod = z.object({
+  total: z.coerce.number().default(0),
+});
+export type TotalSettledTradesZod = z.infer<typeof TotalSettledTradesZod>;
+
+export const OfferingProgressSectionZod = z.object({
+  url: z.string().nullable(),
+  totalSettledTrades: z.coerce.number(),
+  targetAmount: z.coerce.number().nullable().default(1),
+  progressPercentage: z.number(),
+  lastUpdated: z.date(),
+});
+
+export type OfferingProgressSectionZod = z.infer<
+  typeof OfferingProgressSectionZod
+>;
+
+export const InvestorDistributionZod = z.object({
+  individualPercentage: z.coerce.number().default(0),
+  legalEntityPercentage: z.coerce.number().default(0),
+  jointPercentage: z.coerce.number().default(0),
+  retirementPercentage: z.coerce.number().default(0),
+});
+export type InvestorDistributionZod = z.infer<typeof InvestorDistributionZod>;
+
+export const IssuersOfferingDashboardZod = z.object({
+  progressSection: OfferingProgressSectionZod,
+  investors: DashboardIntervalsZod,
+  trades: TradeIntervalsZod,
+  pastWeeklyTrades: PastWeeklyTrades,
+  investorDistribution: InvestorDistributionZod,
+});
+
+export type IssuersOfferingDashboardZod = z.infer<
+  typeof IssuersOfferingDashboardZod
+>;
+
+export const InvestmentOverviewZod = z.object({
+  totalInvested: z.coerce.number().default(0),
+  totalInvestors: z.coerce.number().int().default(0),
+  offeringMax: z.coerce.number().default(0),
+  amountRaised: z.coerce.number().default(0),
+  accreditationPercent: z.coerce.number().default(0),
+});
+export type InvestmentOverviewZod = z.infer<typeof InvestmentOverviewZod>;
+
+export const LeadInvestorWeeklyDataZod = z.object({
+  interval: z.string(),
+  leads: z.coerce.number().int().default(0),
+  investors: z.coerce.number().int().default(0),
+  users: z.coerce.number().int().default(0),
+  weekNumber: z.coerce.number().int().default(0),
+});
+export type LeadInvestorWeeklyDataZod = z.infer<
+  typeof LeadInvestorWeeklyDataZod
+>;
+
+export const LeadsInvestorsZod = z.object({
+  data: z.array(LeadInvestorWeeklyDataZod),
+});
+export type LeadsInvestorsZod = z.infer<typeof LeadsInvestorsZod>;
+
+export const MetricPeriodDataZod = z.object({
+  thisWeek: z.coerce.number().int().default(0),
+  lastWeek: z.coerce.number().int().default(0),
+  thisMonth: z.coerce.number().int().default(0),
+  lastMonth: z.coerce.number().int().default(0),
+});
+export type MetricPeriodDataZod = z.infer<typeof MetricPeriodDataZod>;
+
+export const TradeCountAndAmountZod = z.object({
+  count: z.coerce.number().int().default(0),
+  amount: z.coerce.number().default(0),
+});
+export type TradeCountAndAmountZod = z.infer<typeof TradeCountAndAmountZod>;
+
+export const TradePeriodDataZod = z.object({
+  thisWeek: TradeCountAndAmountZod,
+  lastWeek: TradeCountAndAmountZod,
+  thisMonth: TradeCountAndAmountZod,
+  lastMonth: TradeCountAndAmountZod,
+});
+export type TradePeriodDataZod = z.infer<typeof TradePeriodDataZod>;
+
+export const PerformanceMetricsZod = z.object({
+  leads: MetricPeriodDataZod,
+  investors: MetricPeriodDataZod,
+  users: MetricPeriodDataZod,
+  trades: TradePeriodDataZod,
+});
+export type PerformanceMetricsZod = z.infer<typeof PerformanceMetricsZod>;
+
+export const CartFunnelStepZod = z.object({
+  step: z.string(),
+  count: z.coerce.number().int().default(0),
+  amount: z.coerce.number().default(0),
+});
+export type CartFunnelStepZod = z.infer<typeof CartFunnelStepZod>;
+
+export const CartStatusZod = z.object({
+  funnel: z.array(CartFunnelStepZod),
+});
+export type CartStatusZod = z.infer<typeof CartStatusZod>;
+
+export const OrderFunnelStepZod = z.object({
+  step: z.string(),
+  amount: z.coerce.number().default(0),
+  count: z.coerce.number().int().default(0),
+});
+export type OrderFunnelStepZod = z.infer<typeof OrderFunnelStepZod>;
+
+export const OrderStatusZod = z.object({
+  funnel: z.array(OrderFunnelStepZod),
+});
+export type OrderStatusZod = z.infer<typeof OrderStatusZod>;
+
+export const InvestorInfoZod = z.object({
+  name: z.string(),
+  id: z.string(),
+});
+export type InvestorInfoZod = z.infer<typeof InvestorInfoZod>;
+
+export const InvestorsByStateItemZod = z.object({
+  state: z.string(),
+  investors: z.coerce.number().int().default(0),
+  trades: z.coerce.number().int().default(0),
+});
+export type InvestorsByStateItemZod = z.infer<typeof InvestorsByStateItemZod>;
+
+export const InvestorsByStateZod = z.object({
+  data: z.array(InvestorsByStateItemZod),
+});
+export type InvestorsByStateZod = z.infer<typeof InvestorsByStateZod>;
+
+export const AccreditationBreakdownZod = z.object({
+  accredited: z.coerce.number().default(0),
+  nonAccredited: z.coerce.number().default(0),
+});
+export type AccreditationBreakdownZod = z.infer<
+  typeof AccreditationBreakdownZod
+>;
+
+export const TradeBreakdownZod = z.object({
+  weekNumber: z.number().nullable(),
+  date: z.string(),
+  amount: z.coerce.number().default(0),
+  totalAmount: z.coerce.number().default(0),
+});
+export type TradeBreakdownZod = z.infer<typeof TradeBreakdownZod>;
+
+export const TradesBreakdownZod = z.array(TradeBreakdownZod);
+export type TradesBreakdownZod = z.infer<typeof TradesBreakdownZod>;
+
+export const InvestmentDashboardZod = z.object({
+  overview: InvestmentOverviewZod,
+  performanceMetrics: PerformanceMetricsZod,
+  leadInvestorsWeekly: LeadsInvestorsZod,
+  accreditationBreakdown: AccreditationBreakdownZod,
+  cartStatus: CartStatusZod,
+  orderStatus: OrderStatusZod,
+  tradesBreakdown: TradesBreakdownZod,
+  investorsByState: InvestorsByStateZod,
+});
+export type InvestmentDashboardZod = z.infer<typeof InvestmentDashboardZod>;
+
+export const OfferingsArrayQueryZod = z
+  .string()
+  .min(1, { message: 'Offerings query cannot be empty' })
+  .transform((s) => s.split(',').map((id) => id.trim())) // Split + trim
+  .transform((ids) => {
+    // Deduplicate while preserving first occurrence order
+    const uniqueIds: string[] = [];
+    const seen = new Set<string>();
+
+    ids.forEach((id) => {
+      if (!seen.has(id)) {
+        seen.add(id);
+        uniqueIds.push(id);
+      }
+    });
+
+    return uniqueIds;
+  })
+  .superRefine((ids, ctx) => {
+    // Validate remaining IDs after deduplication
+    ids.forEach((id, index) => {
+      const idCheck = offeringIdSchema.safeParse(id);
+      if (!idCheck.success) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: `Invalid offering ID at position ${index}: ${idCheck.error.message}`,
+          path: [index],
+        });
+      }
+    });
+  });
+
+export type OfferingsArrayQueryZod = z.infer<typeof OfferingsArrayQueryZod>;
+
+export const OfferingTypesQueryZod = z
+  .string()
+  .min(1, { message: 'Offering types cannot be empty' })
+  .transform((s) => s.split(',').map((type) => type.trim())) // Split + trim
+  .transform((types) => {
+    // Deduplicate while preserving first occurrence order
+    const uniqueTypes: string[] = [];
+    const seen = new Set<string>();
+
+    types.forEach((type) => {
+      if (!seen.has(type)) {
+        seen.add(type);
+        uniqueTypes.push(type);
+      }
+    });
+
+    return uniqueTypes;
+  })
+  .superRefine((types, ctx) => {
+    // Validate remaining types after deduplication
+    types.forEach((type, index) => {
+      if (!Object.values(OfferingType).includes(type as OfferingType)) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: `Invalid offering type at position ${index}: Valid values are ${Object.values(OfferingType).join(', ')}`,
+          path: [index],
+        });
+      }
+    });
+  });
+export type OfferingTypesQueryZod = z.infer<typeof OfferingTypesQueryZod>;
+
+export enum DashboardTimeFilteringType {
+  TIME_BASED = 'TIME_BASED',
+  GLOBAL = 'GLOBAL',
+}
+
+export const GetInvestmentDashboardQueryZod = z.object({
+  startDate: dateSchema.optional(),
+  endDate: dateSchema.optional(),
+  offerings: OfferingsArrayQueryZod.optional(),
+  offeringTypes: OfferingTypesQueryZod.optional(),
+  timeFilteringType: z.nativeEnum(DashboardTimeFilteringType),
+  debug: z.preprocess(
+    (val) =>
+      val === 'true' || val === '1'
+        ? true
+        : val === 'false' || val === '0'
+          ? false
+          : val,
+    z.boolean().optional(),
+  ),
+});
+export type GetInvestmentDashboardQueryZod = z.infer<
+  typeof GetInvestmentDashboardQueryZod
+>;
+
+export const defaultDebugData: InvestmentDashboardZod = {
+  overview: {
+    totalInvested: 1300000,
+    totalInvestors: 75,
+    offeringMax: 2000000,
+    amountRaised: 1300000,
+    accreditationPercent: 65,
+  },
+  performanceMetrics: {
+    leads: {
+      thisWeek: 120,
+      lastWeek: 98,
+      thisMonth: 320,
+      lastMonth: 280,
+    },
+    investors: {
+      thisWeek: 75,
+      lastWeek: 62,
+      thisMonth: 215,
+      lastMonth: 186,
+    },
+    users: {
+      thisWeek: 150,
+      lastWeek: 121,
+      thisMonth: 412,
+      lastMonth: 380,
+    },
+    trades: {
+      thisWeek: {
+        count: 5,
+        amount: 1105,
+      },
+      lastWeek: {
+        count: 23,
+        amount: 49782.5,
+      },
+      thisMonth: {
+        count: 13,
+        amount: 3557.5,
+      },
+      lastMonth: {
+        count: 68,
+        amount: 188705,
+      },
+    },
+  },
+  leadInvestorsWeekly: {
+    data: [
+      {
+        weekNumber: 1,
+        interval: 'April 28 - May 04',
+        leads: 27,
+        investors: 15,
+        users: 10,
+      },
+      {
+        weekNumber: 2,
+        interval: 'May 05 - May 11',
+        leads: 32,
+        investors: 18,
+        users: 12,
+      },
+      {
+        weekNumber: 3,
+        interval: 'May 12 - May 18',
+        leads: 42,
+        investors: 21,
+        users: 15,
+      },
+      {
+        weekNumber: 4,
+        interval: 'May 19 - May 25',
+        leads: 38,
+        investors: 16,
+        users: 13,
+      },
+      {
+        weekNumber: 5,
+        interval: 'May 26 - June 01',
+        leads: 45,
+        investors: 24,
+        users: 17,
+      },
+      {
+        weekNumber: 6,
+        interval: 'June 02 - June 08',
+        leads: 36,
+        investors: 19,
+        users: 14,
+      },
+    ],
+  },
+  accreditationBreakdown: {
+    accredited: 67.5,
+    nonAccredited: 31.25,
+  },
+  cartStatus: {
+    funnel: [
+      {
+        step: 'ACCOUNT',
+        count: 4,
+        amount: 5085,
+      },
+      {
+        step: 'CART',
+        count: 19,
+        amount: 39600,
+      },
+      {
+        step: 'PAYMENT',
+        count: 3,
+        amount: 175,
+      },
+      {
+        step: 'SUBDOC',
+        count: 0,
+        amount: 0,
+      },
+    ],
+  },
+  orderStatus: {
+    funnel: [
+      {
+        step: 'PLACED',
+        count: 0,
+        amount: 0,
+      },
+      {
+        step: 'IN_REVIEW',
+        count: 29,
+        amount: 58630,
+      },
+      {
+        step: 'FUNDING',
+        count: 3,
+        amount: 6125,
+      },
+      {
+        step: 'SETTLED',
+        count: 22,
+        amount: 96855,
+      },
+    ],
+  },
+  tradesBreakdown: [
+    { weekNumber: null, date: 'Mar 24', amount: 120, totalAmount: 120 },
+    { weekNumber: null, date: 'Apr 24', amount: 150, totalAmount: 270 },
+    { weekNumber: null, date: 'May 24', amount: 180, totalAmount: 450 },
+    { weekNumber: null, date: 'Jun 24', amount: 200, totalAmount: 650 },
+    { weekNumber: null, date: 'Jul 24', amount: 170, totalAmount: 820 },
+    { weekNumber: null, date: 'Aug 24', amount: 210, totalAmount: 1030 },
+    { weekNumber: null, date: 'Sep 24', amount: 190, totalAmount: 1220 },
+    { weekNumber: null, date: 'Oct 24', amount: 220, totalAmount: 1440 },
+    { weekNumber: null, date: 'Nov 24', amount: 160, totalAmount: 1600 },
+    { weekNumber: null, date: 'Dec 24', amount: 230, totalAmount: 1830 },
+    { weekNumber: null, date: 'Jan 25', amount: 210, totalAmount: 2040 },
+    { weekNumber: null, date: 'Feb 25', amount: 180, totalAmount: 2220 },
+    { weekNumber: null, date: 'Mar 25', amount: 200, totalAmount: 2420 },
+    { weekNumber: null, date: 'Apr 25', amount: 170, totalAmount: 2590 },
+    { weekNumber: null, date: 'May 25', amount: 190, totalAmount: 2780 },
+    { weekNumber: null, date: 'Jun 25', amount: 220, totalAmount: 3000 },
+    { weekNumber: null, date: 'Jul 25', amount: 210, totalAmount: 3210 },
+    { weekNumber: null, date: 'Aug 25', amount: 230, totalAmount: 3440 },
+    { weekNumber: null, date: 'Sep 25', amount: 200, totalAmount: 3640 },
+    { weekNumber: null, date: 'Oct 25', amount: 180, totalAmount: 3820 },
+  ],
+  investorsByState: {
+    data: [
+      {
+        state: 'Alabama',
+        investors: 346,
+        trades: 126,
+      },
+      {
+        state: 'Alaska',
+        investors: 136,
+        trades: 89,
+      },
+      {
+        state: 'Arizona',
+        investors: 580,
+        trades: 182,
+      },
+      {
+        state: 'Arkansas',
+        investors: 244,
+        trades: 95,
+      },
+      {
+        state: 'California',
+        investors: 1750,
+        trades: 623,
+      },
+      {
+        state: 'Colorado',
+        investors: 572,
+        trades: 201,
+      },
+      {
+        state: 'Connecticut',
+        investors: 343,
+        trades: 142,
+      },
+      {
+        state: 'Delaware',
+        investors: 224,
+        trades: 87,
+      },
+      {
+        state: 'Florida',
+        investors: 1425,
+        trades: 410,
+      },
+      {
+        state: 'Georgia',
+        investors: 538,
+        trades: 195,
+      },
+      {
+        state: 'Hawaii',
+        investors: 224,
+        trades: 83,
+      },
+      {
+        state: 'Idaho',
+        investors: 229,
+        trades: 94,
+      },
+      {
+        state: 'Illinois',
+        investors: 625,
+        trades: 231,
+      },
+      {
+        state: 'Indiana',
+        investors: 355,
+        trades: 124,
+      },
+      {
+        state: 'Iowa',
+        investors: 238,
+        trades: 93,
+      },
+      {
+        state: 'Kansas',
+        investors: 232,
+        trades: 87,
+      },
+      {
+        state: 'Kentucky',
+        investors: 245,
+        trades: 91,
+      },
+      {
+        state: 'Louisiana',
+        investors: 361,
+        trades: 137,
+      },
+      {
+        state: 'Maine',
+        investors: 109,
+        trades: 42,
+      },
+      {
+        state: 'Maryland',
+        investors: 364,
+        trades: 145,
+      },
+      {
+        state: 'Massachusetts',
+        investors: 481,
+        trades: 178,
+      },
+      {
+        state: 'Michigan',
+        investors: 508,
+        trades: 187,
+      },
+      {
+        state: 'Minnesota',
+        investors: 374,
+        trades: 142,
+      },
+      {
+        state: 'Mississippi',
+        investors: 233,
+        trades: 85,
+      },
+      {
+        state: 'Missouri',
+        investors: 374,
+        trades: 143,
+      },
+      {
+        state: 'Montana',
+        investors: 212,
+        trades: 74,
+      },
+      {
+        state: 'Nebraska',
+        investors: 229,
+        trades: 86,
+      },
+      {
+        state: 'Nevada',
+        investors: 366,
+        trades: 143,
+      },
+      {
+        state: 'New Hampshire',
+        investors: 215,
+        trades: 79,
+      },
+      {
+        state: 'New Jersey',
+        investors: 519,
+        trades: 193,
+      },
+      {
+        state: 'New Mexico',
+        investors: 226,
+        trades: 83,
+      },
+      {
+        state: 'New York',
+        investors: 860,
+        trades: 307,
+      },
+      {
+        state: 'North Carolina',
+        investors: 558,
+        trades: 212,
+      },
+      {
+        state: 'North Dakota',
+        investors: 217,
+        trades: 76,
+      },
+      {
+        state: 'Ohio',
+        investors: 511,
+        trades: 189,
+      },
+      {
+        state: 'Oklahoma',
+        investors: 349,
+        trades: 128,
+      },
+      {
+        state: 'Oregon',
+        investors: 340,
+        trades: 125,
+      },
+      {
+        state: 'Pennsylvania',
+        investors: 554,
+        trades: 209,
+      },
+      {
+        state: 'Rhode Island',
+        investors: 209,
+        trades: 71,
+      },
+      {
+        state: 'South Carolina',
+        investors: 363,
+        trades: 138,
+      },
+      {
+        state: 'South Dakota',
+        investors: 215,
+        trades: 75,
+      },
+      {
+        state: 'Tennessee',
+        investors: 372,
+        trades: 142,
+      },
+      {
+        state: 'Texas',
+        investors: 1509,
+        trades: 487,
+      },
+      {
+        state: 'Utah',
+        investors: 362,
+        trades: 139,
+      },
+      {
+        state: 'Vermont',
+        investors: 208,
+        trades: 69,
+      },
+      {
+        state: 'Virginia',
+        investors: 496,
+        trades: 183,
+      },
+      {
+        state: 'Washington',
+        investors: 517,
+        trades: 192,
+      },
+      {
+        state: 'West Virginia',
+        investors: 210,
+        trades: 73,
+      },
+      {
+        state: 'Wisconsin',
+        investors: 369,
+        trades: 138,
+      },
+      {
+        state: 'Wyoming',
+        investors: 217,
+        trades: 76,
+      },
+    ],
+  },
+};
+
+export const DocumentSummaryFilterZod = z.object({
+  type: z
+    .string()
+    .optional()
+    .transform((val) => {
+      if (!val) return undefined;
+      return val
+        .split(',')
+        .map((item) => item.trim())
+        .filter((item) => item.length > 0);
+    })
+    .pipe(z.array(FileLabelsEnum).optional())
+    .openapi({ example: FileLabels.OTHER }),
+});
+
+export const DocumentSummaryZod = z.object({
+  accountId: accountIdSchema,
+  accountName: z.string(),
+  category: z.string(),
+  type: z.string(),
+  count: z.number().int().default(0),
+});
+export type DocumentSummaryZod = z.infer<typeof DocumentSummaryZod>;
+
+export const IPaginatedDocumentSummaryResponse = z.object({
+  items: z.array(DocumentSummaryZod),
+  meta: IPaginationMeta,
+});
+export type IPaginatedDocumentSummaryResponse = z.infer<
+  typeof IPaginatedDocumentSummaryResponse
+>;