@dalmore/api-contracts 0.0.0-dev.2dc8e92 → 0.0.0-dev.4bb6b7a

package/common/types/offering.types.ts

@@ -15,6 +15,9 @@ import {
   SortBy,
   OfferingVersioningType,
   OfferingOnboardingStatus,
+  AssetType,
+  DurationType,
+  StringToBooleanSchema,
 } from './common.types';
 import { IBaseEntity } from './entity.types';
 import { fileIdSchema, FileZod } from './file.types';
@@ -24,6 +27,7 @@ import {
   InvestorsOfferingsIncludeQuery,
 } from './investors-offering.types';
 import { OfferingStatus } from './issuer-offering.types';
+import { postAssetRefinement, AssetTemplateType } from './asset.types';
 
 export enum OfferingFeeType {
   FIXED = 'FIXED',
@@ -115,7 +119,7 @@ export const IPaginatedOffering = z.object({
 });
 export type IPaginatedOffering = z.infer<typeof IPaginatedOffering>;
 
-export const PatchOffering = z.object({
+export const PatchOfferingBase = z.object({
   name: z.string().optional(),
   description: z.string().nullable().optional(),
   tid: z.string().optional(),
@@ -148,8 +152,8 @@ export const PatchOffering = z.object({
     .openapi({ example: 5000 })
     .optional()
     .nullable(),
-  startAt: dateSchema.optional(),
-  endAt: dateSchema.optional(),
+  startAt: dateSchema.optional().openapi({ example: '10/20/2024' }),
+  endAt: dateSchema.optional().openapi({ example: '10/27/2024' }),
   platform: z.string().optional(),
   coverArtId: z
     .lazy(() => fileIdSchema)
@@ -175,16 +179,108 @@ export const PatchOffering = z.object({
   showTotalRaised: z.boolean().optional(),
   issuerId: issuerIdSchema.optional(),
 });
-
+export const PatchOffering = PatchOfferingBase.merge(
+  z.object({
+    assetName: z
+      .string()
+      .min(2)
+      .max(50)
+      .optional()
+      .openapi({ example: 'Asset name' }),
+    assetType: z
+      .nativeEnum(AssetType)
+      .optional()
+      .openapi({ example: AssetType.STOCK }),
+    pricePerUnit: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 2000 }),
+    totalUnits: z
+      .number()
+      .min(1)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 5200 }),
+    yield: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1200 }),
+    duration: z
+      .number()
+      .min(1)
+      .max(1000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1 }),
+    durationType: z
+      .nativeEnum(DurationType)
+      .nullable()
+      .optional()
+      .openapi({ example: DurationType.DAY }),
+    template: z
+      .nativeEnum(AssetTemplateType)
+      .default(AssetTemplateType.STANDARD)
+      .openapi({ example: AssetTemplateType.STANDARD })
+      .nullable()
+      .optional(),
+    tiers: z.array(z.number().positive()).nullable().optional(),
+    enableBonus: z.boolean().optional(),
+  }),
+);
 export type PatchOffering = z.infer<typeof PatchOffering>;
 
-export const PostComplianceOffering = PatchOffering.merge(
+export const PostComplianceOffering = PatchOfferingBase.merge(
   z.object({
     accountId: accountIdSchema,
+    managedBy: z.nativeEnum(ManagedByType).optional(),
+    assetName: z.string().min(2).max(50).openapi({ example: 'Asset name' }),
+    assetType: z.nativeEnum(AssetType).openapi({ example: AssetType.STOCK }),
+    pricePerUnit: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .openapi({ example: 2000 }),
+    totalUnits: z
+      .number()
+      .min(1)
+      .max(10000000000)
+      .nullable()
+      .openapi({ example: 5200 }),
+    yield: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1200 }),
+    duration: z
+      .number()
+      .min(1)
+      .max(1000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1 }),
+    durationType: z
+      .nativeEnum(DurationType)
+      .nullable()
+      .optional()
+      .openapi({ example: DurationType.DAY }),
+    template: z
+      .nativeEnum(AssetTemplateType)
+      .default(AssetTemplateType.STANDARD)
+      .openapi({ example: AssetTemplateType.STANDARD }),
+    tiers: z.array(z.number().positive()).nullable().optional(),
+    enableBonus: z.boolean().default(false).optional(),
   }),
-).extend({
-  managedBy: z.nativeEnum(ManagedByType).optional(),
-});
+).superRefine(postAssetRefinement);
 export type PostComplianceOffering = z.infer<typeof PostComplianceOffering>;
 
 export const offeringsInclude = z.enum([
@@ -251,15 +347,7 @@ export const OfferingFiltersZod = 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(),
@@ -546,11 +634,9 @@ export type PaginatedPendingOfferingSummaryResponse = z.infer<
 >;
 
 export type OfferingUpdateFields = {
-  platform?: string;
-  platformSettings?: string | null;
   managedBy?: ManagedByType | null;
-  enabled?: boolean;
   showTotalRaised?: boolean;
+  enabled?: boolean;
 };
 
 export const ReviewOfferingOnboarding = z.object({

package/common/types/site-settings.types.ts

@@ -3,6 +3,7 @@ import { z } from 'zod';
 import { fileIdSchema } from './file.types';
 import {
   AccountZod,
+  EmailSchema,
   HexCodeColorSchema,
   IPaginationMeta,
   SubdomainSchema,
@@ -462,7 +463,7 @@ export const GetSenderEmailZod = z.object({
 export type GetSenderEmailZod = z.infer<typeof GetSenderEmailZod>;
 
 export const PatchSenderEmailZod = z.object({
-  senderEmail: z.string().email().openapi({ example: 'example@example.com' }),
+  senderEmail: EmailSchema,
 });
 export type PatchSenderEmailZod = z.infer<typeof PatchSenderEmailZod>;
 

package/common/types/site.types.ts

@@ -5,6 +5,7 @@ import {
   AccountStatus,
   AccountZod,
   IPaginationMeta,
+  StringToBooleanSchema,
   UrlSchema,
 } from './common.types';
 import { accountIdSchema } from './account.types';
@@ -73,15 +74,7 @@ export const SitesParamSchema = z.object({
 export const SitesFiltersZod = z.object({
   url: z.string().optional(),
   accountId: accountIdSchema.optional(),
-  enabled: z.preprocess(
-    (val) =>
-      val === 'true' || val === '1'
-        ? true
-        : val === 'false' || val === '0'
-          ? false
-          : val,
-    z.boolean().optional(),
-  ),
+  enabled: StringToBooleanSchema.optional(),
 });
 
 const sitesInclude = z.enum(['account']);

package/common/types/{trade-line-item.type.ts → trade-line-item.types.ts}

@@ -8,6 +8,7 @@ import {
   IPaginationMeta,
   OfferingType,
   SignatureStatus,
+  StringToBooleanSchema,
 } from './common.types';
 import { fileIdSchema } from './file.types';
 import { accountIdSchema } from './account.types';
@@ -107,15 +108,7 @@ export type TradeLineItemQuery = z.infer<typeof TradeLineItemQuery>;
 
 export const TradeLineItemFiltersQuery = z.object({
   accountId: accountIdSchema.optional(),
-  hasSubdoc: z.preprocess(
-    (val) =>
-      val === 'true' || val === '1'
-        ? true
-        : val === 'false' || val === '0'
-          ? false
-          : val,
-    z.boolean().optional(),
-  ),
+  hasSubdoc: StringToBooleanSchema.optional(),
   saStatus: z.nativeEnum(SignatureStatus).optional(),
   offeringId: z.lazy(() => offeringIdSchema).optional(),
   search: z.string().max(50).optional(),

package/common/types/trade.types.ts

@@ -22,12 +22,13 @@ import {
   AccountStatus,
   SavedQuery,
 } from './common.types';
-import { offeringIdSchema } from './offering.types';
+import { IOffering, offeringIdSchema } from './offering.types';
 import { IBaseEntity } from './entity.types';
 import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
 import {
   paymentMethodIdSchema,
+  PaymentMethodResponse,
   PaymentMethodType,
 } from './payment-methods.types';
 import {
@@ -35,11 +36,12 @@ import {
   InvestorAccountExportFilters,
   ComplianceInvestorAccountExportFilters,
   RegisteredInvestorUserRawZod,
+  IInvestorAccount,
 } from './investor-account.types';
 import {
   tradeLineItemIdSchema,
   TradeLineItemZod,
-} from './trade-line-item.type';
+} from './trade-line-item.types';
 import { TradeAdjustmentZod } from './trade-adjustment.type';
 import { TransactionZod } from './transaction.types';
 import { accountIdSchema } from './account.types';
@@ -55,8 +57,71 @@ import {
 } from './secondary-trade.types';
 import { InvestorAccount } from '../../investor-accounts/entities/investor-account.entity';
 import { Trade } from '../../trades/entities/trade.entity';
+import { fileIdSchema } from './file.types';
 
 extendZodWithOpenApi(z);
+
+// Zod schemas for attach subdoc endpoints
+export const PostAttachSubdocBody = z.object({
+  lineItemId: tradeLineItemIdSchema.openapi({
+    example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja',
+  }),
+  fileId: z
+    .lazy(() => fileIdSchema)
+    .openapi({ example: 'file_01je6ht4b8fbmttkzh2hs82xqp' }),
+  primarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .openapi({ example: 'SIGNED' }),
+  secondarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .optional()
+    .openapi({ example: 'SIGNED' }),
+});
+export type PostAttachSubdocBody = z.infer<typeof PostAttachSubdocBody>;
+
+export const PutAttachSubdocBody = z.object({
+  lineItemId: tradeLineItemIdSchema
+    .optional()
+    .openapi({ example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja' }),
+  fileId: z
+    .lazy(() => fileIdSchema)
+    .optional()
+    .openapi({ example: 'file_01je6ht4b8fbmttkzh2hs82xqp' }),
+  primarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .optional()
+    .openapi({ example: 'SIGNED' }),
+  secondarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .optional()
+    .openapi({ example: 'SIGNED' }),
+});
+export type PutAttachSubdocBody = z.infer<typeof PutAttachSubdocBody>;
+
+export const PatchSubdocSignatureBody = z.object({
+  lineItemId: tradeLineItemIdSchema.optional().openapi({
+    example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja',
+    description:
+      'Optional. If not provided, updates the first line item with an attached subdoc. Required for trades with multiple line items.',
+  }),
+  primarySignatureStatus: z.nativeEnum(SignatureStatus).optional().openapi({
+    example: 'SIGNED',
+    description: 'Primary signer signature status',
+  }),
+  secondarySignatureStatus: z.nativeEnum(SignatureStatus).optional().openapi({
+    example: 'SIGNED',
+    description:
+      'Secondary signer signature status. Only applicable for JOINT investor accounts.',
+  }),
+});
+export type PatchSubdocSignatureBody = z.infer<typeof PatchSubdocSignatureBody>;
+
+export const AttachSubdocResponse = z.object({
+  success: z.boolean(),
+  message: z.string(),
+});
+export type AttachSubdocResponse = z.infer<typeof AttachSubdocResponse>;
+
 export const CheckResultsSchema = z.object({
   fundingStatus: z.boolean(),
   agreementStatus: z.boolean(),
@@ -69,6 +134,7 @@ export const CheckResultsSchema = z.object({
 export type CheckResults = z.infer<typeof CheckResultsSchema>;
 
 export const TradeIdPrefix = 'trade';
+export const TradeSnapshotIdPrefix = 'trade_snapshot';
 
 export const tradeIdSchema = z.string().refine(
   (value) => {
@@ -107,6 +173,21 @@ export const tradeIdOrTidSchema = z.union([
     .openapi({ example: 'tid_00041061050r3gg28a1c60t3gf' }),
 ]);
 
+export const tradeSnapshotIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === TradeSnapshotIdPrefix;
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid trade snapshot ID format. Must be a valid TypeID with "trade_snapshot" prefix. ex: trade_snapshot_00041061050r3gg28a1c60t3gf',
+  },
+);
+
 export enum SaStatus {
   PENDING = BaseStatus.PENDING,
   SIGNED = BaseStatus.SIGNED,
@@ -202,11 +283,30 @@ export const PatchSaLogSchema = z.object({
 
 export type PatchSaLogSchema = z.infer<typeof PatchSaLogSchema>;
 
+export const TradeBalanceResultZod = z.object({
+  tradeAdjustments: z.number().multipleOf(0.01),
+  chargedAmount: z.number().multipleOf(0.01),
+  balance: z.number().multipleOf(0.01),
+});
+export type TradeBalanceResultZod = z.infer<typeof TradeBalanceResultZod>;
+
 export const TradeZod = IBaseEntity.extend({
   investorAccountId: z.lazy(() => investorAccountIdSchema.nullable()),
+  investorAccount: z
+    .lazy(() => IInvestorAccount)
+    .optional()
+    .nullable(),
+  offering: z
+    .lazy(() => IOffering)
+    .optional()
+    .nullable(),
   accountId: accountIdSchema.nullable(),
   offeringId: z.lazy(() => offeringIdSchema.nullable()),
   paymentMethodId: z.lazy(() => paymentMethodIdSchema).nullable(),
+  paymentMethod: z
+    .lazy(() => PaymentMethodResponse)
+    .optional()
+    .nullable(),
   userId: z.lazy(() => userIdSchema.nullable()),
   tradeNumber: z.string(),
   ip: z.string().nullable(),
@@ -272,6 +372,21 @@ export const TradeZod = IBaseEntity.extend({
 });
 export type TradeZod = z.infer<typeof TradeZod>;
 
+export enum SnapshotEvent {
+  COMPLIANCE_APPROVED = 'COMPLIANCE_APPROVED',
+  COMPLIANCE_REJECTED = 'COMPLIANCE_REJECTED',
+  CANCELLED = 'CANCELLED',
+  PLACED = 'PLACED',
+  SETTLED = 'SETTLED',
+}
+
+export const GetTradeSnapshotEventsResponse = z.object({
+  events: z.array(z.nativeEnum(SnapshotEvent)),
+});
+export type GetTradeSnapshotEventsResponse = z.infer<
+  typeof GetTradeSnapshotEventsResponse
+>;
+
 export const IPaginatedTrade = z.object({
   items: z.array(TradeZod),
   meta: IPaginationMeta,
@@ -354,6 +469,7 @@ export const TradeFiltersZod = z.object({
     .openapi({
       example: 'issuer_01jfw4q6qef30s6fpqtsxw94ya',
     }),
+  snapshotEvent: z.nativeEnum(SnapshotEvent).optional(),
   offeringType: z.nativeEnum(OfferingType).optional(),
   managedBy: z.nativeEnum(ManagedByType).optional(),
   platform: z.nativeEnum(Platforms).optional(),

package/common/types/transaction.types.ts

@@ -1,10 +1,11 @@
+import { z } from 'zod';
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
 import {
   dateSchema,
   InvestorAccountType,
   numberPrecisionSchema,
 } from './common.types';
-import { z } from 'zod';
 import { IBaseEntity } from './entity.types';
 import { accountIdSchema } from './account.types';
 import {
@@ -18,7 +19,9 @@ import {
   investorAccountIdSchema,
 } from './investor-account.types';
 import { TransactionStatus, TransactionType } from './common.types';
+import { userIdSchema } from './user.types';
 export { TransactionStatus, TransactionType };
+extendZodWithOpenApi(z);
 
 export enum RefundPaymentMethod {
   CHECK = 'CHECK',
@@ -115,6 +118,14 @@ export type InvestorPostTransactionZod = z.infer<
   typeof InvestorPostTransactionZod
 >;
 
+export const ClientPostTransactionZod = InvestorPostTransactionZod.extend({
+  userId: z
+    .lazy(() => userIdSchema)
+    .openapi({ example: 'user_01j5y5ghx5fg68d663j1fvy2x7' }),
+});
+
+export type ClientPostTransactionZod = z.infer<typeof ClientPostTransactionZod>;
+
 export const refundTransactionIdSchema = z.string().refine(
   (value) => {
     try {

package/common/types/trusted-contact.types.ts

@@ -2,7 +2,11 @@ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
 import { z } from 'zod';
 import { IBaseEntity } from './entity.types';
-import { IPaginationMeta, TrustedContactRelationship } from './common.types';
+import {
+  EmailSchema,
+  IPaginationMeta,
+  TrustedContactRelationship,
+} from './common.types';
 import { PhoneZodSchema } from './phone.type';
 import { AddressSchema } from './address.types';
 import { investorAccountIdSchema } from './investor-account.types';
@@ -68,7 +72,7 @@ export const PostTrustedContactZod = z
   .object({
     firstName: z.string().min(1).max(255).openapi({ example: 'John' }),
     lastName: z.string().min(1).max(255).openapi({ example: 'Doe' }),
-    email: z.string().email().openapi({ example: 'john.doe@example.com' }),
+    email: EmailSchema.openapi({ example: 'john.doe@example.com' }),
     phone: PhoneZodSchema.nullable().optional(),
     relationship: z
       .nativeEnum(TrustedContactRelationship)
@@ -92,11 +96,7 @@ export const PatchTrustedContactZod = z
       .optional()
       .openapi({ example: 'John' }),
     lastName: z.string().min(1).max(255).optional().openapi({ example: 'Doe' }),
-    email: z
-      .string()
-      .email()
-      .optional()
-      .openapi({ example: 'john.doe@example.com' }),
+    email: EmailSchema.optional(),
     phone: PhoneZodSchema.nullable().optional(),
     relationship: z.nativeEnum(TrustedContactRelationship).optional().openapi({
       example: TrustedContactRelationship.CHILD,

package/common/types/user.types.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import {
   AccountStatus,
   AccountWithoutUsersZod,
@@ -7,12 +8,12 @@ import {
   ManagedByType,
   OfferingType,
   PortalType,
+  StringToBooleanSchema,
   UserRole,
-  UserStatus,
   UserType,
+  EmailSchema,
 } from './common.types';
 import { dateOrString, IBaseEntity } from './entity.types';
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { PhoneZodSchema } from './phone.type';
 import { IInvestorAccount } from './investor-account.types';
 import { TradeZod } from './trade.types';
@@ -51,6 +52,11 @@ export const UserDeleteResponse = z.object({
 });
 export type UserDeleteResponse = z.infer<typeof UserDeleteResponse>;
 
+export const UserRestoreResponse = z.object({
+  message: z.string(),
+});
+export type UserRestoreResponse = z.infer<typeof UserRestoreResponse>;
+
 export const GetMeResponse = IBaseEntity.extend({
   accountId: z.string().nullable(),
   accountName: z.string().nullable(),
@@ -59,7 +65,7 @@ export const GetMeResponse = IBaseEntity.extend({
   email: z.string().email(),
   provider: z.string(),
   active: z.boolean(),
-  status: z.lazy(() => z.nativeEnum(UserStatus)),
+  locked: z.boolean(),
   lastLoginAt: dateOrString.nullable(),
   loginCount: z.number(),
   role: z.string(),
@@ -142,11 +148,7 @@ export const UserMeUpdateZod = z.object({
   firstName: z.string().optional(),
   lastName: z.string().optional(),
   password: z.string().min(6).optional(),
-  email: z
-    .string()
-    .email()
-    .transform((val) => val.toLowerCase())
-    .optional(),
+  email: EmailSchema.optional(),
 });
 
 export const UserZod = IBaseEntity.extend({
@@ -157,7 +159,7 @@ export const UserZod = IBaseEntity.extend({
   onboarding: z.string().nullable(),
   account: AccountWithoutUsersZod.optional(),
   active: z.boolean(),
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
   userLogin: IBaseEntity.extend({
     firstName: z.string(),
     lastName: z.string(),
@@ -179,27 +181,9 @@ export const UserFiltersZod = z.object({
   search: z.string().max(50).optional(),
   role: z.nativeEnum(UserRole).optional(),
   portal: z.string().optional(),
-  status: z.nativeEnum(UserStatus).optional(),
-  active: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'active must be a boolean string',
-    })
-    .transform((v) => {
-      if (!v) return undefined;
-      return v === 'true';
-    }),
-  twoFactorEnabled: z
-    .string()
-    .optional()
-    .refine((v) => !v || v === 'true' || v === 'false', {
-      message: 'twoFactorEnabled must be a boolean string',
-    })
-    .transform((v) => {
-      if (!v) return undefined;
-      return v === 'true';
-    }),
+  locked: StringToBooleanSchema.optional(),
+  active: StringToBooleanSchema.optional(),
+  twoFactorEnabled: StringToBooleanSchema.optional(),
 });
 
 const usersInclude = z.enum(['account', 'role']);
@@ -274,7 +258,7 @@ export type IssuerUsersStatusUpdateResponse = z.infer<
 >;
 
 export const UpdateLockedStatus = z.object({
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
 });
 
 export type UpdateLockedStatus = z.infer<typeof UpdateLockedStatus>;
@@ -285,7 +269,7 @@ export const UsersSummaryFilterZod = z.object({
   portalType: z.nativeEnum(PortalType).optional(),
   search: z.string().trim().max(50).optional(),
   selectRole: z.nativeEnum(UserRole).optional(),
-  status: z.nativeEnum(UserStatus).optional(),
+  locked: StringToBooleanSchema.optional(),
 });
 export type UsersSummaryFilterZod = z.infer<typeof UsersSummaryFilterZod>;
 
@@ -299,7 +283,7 @@ export const UsersSummaryZod = z.object({
   portalType: z.string(),
   loginCount: z.number().int(),
   lastLogin: z.date(),
-  status: z.nativeEnum(UserStatus),
+  locked: z.boolean(),
 });
 export type UsersSummaryZod = z.infer<typeof UsersSummaryZod>;