@dalmore/api-contracts 0.0.0-dev.7c97041 → 0.0.0-dev.988f3c3

package/common/types/account-setting.types.ts

@@ -0,0 +1,65 @@
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
+import { z } from 'zod';
+import { TypeID } from 'typeid-js';
+import { IBaseEntity } from './entity.types';
+import { IPaginationMeta } from './common.types';
+import { accountIdSchema } from './account.types';
+
+extendZodWithOpenApi(z);
+
+export const accountSettingIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === 'account_setting';
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid account setting ID format. Must be a valid TypeID with "account_setting" prefix.',
+  },
+);
+
+export const IAccountSettingZod = IBaseEntity.extend({
+  id: accountSettingIdSchema.openapi({
+    example: 'account_setting_01j5y5ghx8fvc83dmx3pznq7hv',
+  }),
+  accountId: z.string().openapi({
+    example: 'account_01j5y5ghx8fvc83dmx3pznq7hv',
+  }),
+});
+export type IAccountSettingZod = z.infer<typeof IAccountSettingZod>;
+
+export const IPaginatedAccountSetting = z.object({
+  items: z.array(IAccountSettingZod),
+  meta: IPaginationMeta,
+});
+export type IPaginatedAccountSetting = z.infer<typeof IPaginatedAccountSetting>;
+
+export const AccountSettingsFilters = z.object({
+  accountId: accountIdSchema.optional(),
+});
+export type AccountSettingsFilters = z.infer<typeof AccountSettingsFilters>;
+
+export const accountSettingsInclude = z.enum(['notificationChannels']);
+
+export const AccountSettingsIncludeQuery = z.object({
+  include: z
+    .string()
+    .optional()
+    .transform((str) => (str ? str.split(',') : []))
+    .refine(
+      (includes) =>
+        includes.every((include) =>
+          accountSettingsInclude.options.includes(include as any),
+        ),
+      {
+        message: `Invalid include value. Valid values are: ${accountSettingsInclude.options.join(', ')}`,
+      },
+    ),
+});
+export type AccountSettingsIncludeQuery = z.infer<
+  typeof AccountSettingsIncludeQuery
+>;

package/common/types/account.types.ts

@@ -91,6 +91,7 @@ export const AccountFiltersZod = z.object({
 const accountsInclude = z.enum([
   'accountManager',
   'accountIntegrations',
+  'accountSettings',
   'apiKeys',
   'assets',
   'dataRooms',

package/common/types/bonus-tier.types.ts

@@ -98,6 +98,15 @@ export type EstimateBonusTierCalculationZod = z.infer<
   typeof EstimateBonusTierCalculationZod
 >;
 
+export const ComplianceEstimateBonusTierCalculationZod =
+  EstimateBonusTierCalculationZod.and(
+    z.object({
+      accountId: accountIdSchema,
+    }),
+  );
+export type ComplianceEstimateBonusTierCalculationZod = z.infer<
+  typeof ComplianceEstimateBonusTierCalculationZod
+>;
 export const EstimateBonusTierCalculationResponseZod = z.object({
   bonusTierId: bonusTierIdSchema
     .nullable()
@@ -145,3 +154,27 @@ export const CompliancePostBonusTierZod = PostBonusTierZod.extend({
 export type CompliancePostBonusTierZod = z.infer<
   typeof CompliancePostBonusTierZod
 >;
+export const PurchaseCalculationZod = z.object({
+  assetId: assetIdSchema,
+  totalAmount: z.number().positive().openapi({ example: 1000 }),
+  purchasedShares: z.number().positive().int().openapi({ example: 100 }),
+});
+export type PurchaseCalculationZod = z.infer<typeof PurchaseCalculationZod>;
+
+export const PurchaseCalculationResponseZod = z.object({
+  bonusTierId: bonusTierIdSchema
+    .nullable()
+    .openapi({ example: 'bonus_tier_01j5y5ghx5fg68d663j1fvy2x7' }),
+  assetId: assetIdSchema.openapi({
+    example: 'asset_00041061050r3gg28a1c60t3gf',
+  }),
+  type: z
+    .nativeEnum(BonusType)
+    .nullable()
+    .openapi({ example: BonusType.PERCENTAGE }),
+  bonusShares: z.number().int().openapi({ example: 100 }),
+});
+
+export type PurchaseCalculationResponseZod = z.infer<
+  typeof PurchaseCalculationResponseZod
+>;

package/common/types/cart.types.ts

@@ -3,6 +3,7 @@ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TradeStatus } from './common.types';
 import { investorAccountIdSchema } from './investor-account.types';
 import { paymentMethodIdSchema } from './payment-methods.types';
+import { userIdSchema } from './user.types';
 
 extendZodWithOpenApi(z);
 
@@ -10,7 +11,9 @@ export const PlaceTradeResponse = z.object({
   tradeStatus: z.nativeEnum(TradeStatus).optional(),
 });
 export const PlaceTradeBody = z.object({});
-
+export const ClientPlacetradeBody = z.object({
+  userId: userIdSchema,
+});
 export const PatchCartBody = z.object({
   investorAccountId: investorAccountIdSchema.optional(),
   paymentMethodId: paymentMethodIdSchema.optional(),

package/common/types/common.types.ts

@@ -111,6 +111,10 @@ export enum HttpMethod {
   OPTIONS = 'OPTIONS',
 }
 
+export enum UserStatus {
+  ACTIVE = 'ACTIVE',
+  LOCKED = 'LOCKED',
+}
 export const SENSITIVE_PATTERNS = [
   /password/i,
   /credit.*card/i,
@@ -200,11 +204,6 @@ export enum UserType {
   DEMO = 'DEMO',
 }
 
-export enum UserStatus {
-  ACTIVE = 'ACTIVE',
-  LOCKED = 'LOCKED',
-}
-
 export enum UserRole {
   API_KEY = 'API_KEY',
   IMPORT = 'IMPORT',
@@ -306,7 +305,7 @@ export const AuthUserReq = BaseAuthReq.extend({
   lastName: z.string(),
   email: z.string().email(),
   provider: z.string(),
-  status: z.lazy(() => z.nativeEnum(UserStatus)),
+  locked: z.boolean(),
   lastLoginAt: z.date().nullable(),
   loginCount: z.number(),
   requiresTwoFactorSetup: z.boolean().optional(),
@@ -1518,3 +1517,14 @@ export const SUBJECT_TYPE_MAP: Record<BulkExportType, string> = {
   [BulkExportType.SECONDARY_CUSTOMERS]: 'Secondary Customers',
   [BulkExportType.SECONDARY_TRADES]: 'Secondary Trades',
 };
+
+export const StringToBooleanSchema = z.preprocess(
+  (val) =>
+    val === 'true' || val === '1'
+      ? true
+      : val === 'false' || val === '0'
+        ? false
+        : val,
+  z.boolean(),
+);
+export type StringToBooleanSchema = z.infer<typeof StringToBooleanSchema>;

package/common/types/dashboard.types.ts

@@ -7,6 +7,7 @@ import {
   FileLabels,
   IPaginationMeta,
   OfferingType,
+  StringToBooleanSchema,
 } from './common.types';
 import { accountIdSchema } from './account.types';
 
@@ -330,15 +331,7 @@ export const GetInvestmentDashboardQueryZod = z.object({
   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(),
-  ),
+  debug: StringToBooleanSchema.optional(),
 });
 export type GetInvestmentDashboardQueryZod = z.infer<
   typeof GetInvestmentDashboardQueryZod

package/common/types/individuals.types.ts

@@ -12,9 +12,7 @@ import {
   InvestorAccountType,
   SetupStatusType,
   SetupStepType,
-  ComplianceReview,
   RetirementAccountType,
-  TradeStatus,
   EmploymentStatus,
   SourceOfIncome,
   AMLProvider,
@@ -60,8 +58,8 @@ export enum aicQuestionnaireQuestionType {
 }
 
 export enum FilterBy {
-  TRADE = 'TRADE',
-  INVESTOR = 'INVESTOR',
+  ALL = 'ALL',
+  PENDING_TRADES = 'PENDING_TRADES',
 }
 
 export const aicQuestionnaireQuestion = z.object({
@@ -243,17 +241,6 @@ export const IndividualFiltersZod = z.object({
 
 export const ComplianceIndividualFiltersZod = IndividualFiltersZod.extend({
   filterBy: z.nativeEnum(FilterBy).optional(),
-  tradeStatus: z.nativeEnum(TradeStatus).optional(),
-  complianceReview: z.nativeEnum(ComplianceReview).optional(),
-  hasPendingTrades: z.preprocess(
-    (val) =>
-      val === 'true' || val === '1'
-        ? true
-        : val === 'false' || val === '0'
-          ? false
-          : val,
-    z.boolean().optional(),
-  ),
 });
 
 /**

package/common/types/issuer-offering.types.ts

@@ -10,6 +10,7 @@ import {
   ComplianceReview,
   DurationType,
   AssetType,
+  StringToBooleanSchema,
 } from './common.types';
 import { IBaseEntity } from './entity.types';
 import { IIssuer, issuerIdSchema } from './issuer.types';
@@ -193,38 +194,39 @@ export const PatchIssuerOffering = z.object({
     .max(100)
     .optional()
     .openapi({ example: 'Airbnb IPO' }),
+  type: z
+    .nativeEnum(OfferingType)
+    .optional()
+    .openapi({ example: OfferingType.REG_D }),
   targetAmount: z
     .number()
     .min(0)
     .max(10000000000)
     .optional()
     .openapi({ example: 120000 }),
-  raiseAmount: z
-    .number()
-    .min(0)
-    .max(10000000000)
-    .optional()
-    .openapi({ example: 200000 }),
   minInvestment: z
     .number()
     .min(0)
     .max(10000000000)
+    .nullable()
     .optional()
     .openapi({ example: 1000 }),
   maxInvestment: z
     .number()
     .min(0)
     .max(10000000000)
+    .nullable()
     .optional()
     .openapi({ example: 20000 }),
   contingencyAmount: z
     .number()
     .min(0)
     .max(10000000000)
+    .nullable()
     .optional()
     .openapi({ example: 5000 }),
-  startAt: dateSchema.optional().openapi({ example: '10/20/2024' }),
-  endAt: dateSchema.optional().openapi({ example: '10/27/2024' }),
+  startAt: dateSchema.nullable().optional().openapi({ example: '10/20/2024' }),
+  endAt: dateSchema.nullable().optional().openapi({ example: '10/27/2024' }),
   cancellationPeriod: z
     .number()
     .min(1)
@@ -370,15 +372,7 @@ export const IssuerOfferingsFilterZod = z.object({
   issuerId: z.lazy(() => issuerIdSchema).optional(),
   type: z.nativeEnum(OfferingType).optional(),
   status: z.nativeEnum(ComplianceReview).optional(),
-  enabled: z.preprocess(
-    (val) =>
-      val === 'true' || val === '1'
-        ? true
-        : val === 'false' || val === '0'
-          ? false
-          : val,
-    z.boolean().optional(),
-  ),
+  enabled: StringToBooleanSchema.optional(),
   managedBy: z.nativeEnum(ManagedByType).optional(),
   versioningType: z.nativeEnum(OfferingVersioningType).optional(),
   combinedStatus: z.nativeEnum(OfferingStatus).optional(),