@dalmore/api-contracts 1.0.5 → 1.0.6

package/src/common/types/legal-entity.types.ts

@@ -0,0 +1,185 @@
+import { z } from 'zod';
+import { IBaseEntity } from './entity.types';
+import {
+  dateSchema,
+  IPaginationMeta,
+  KYBStatus,
+  SanctionsStatus,
+  SetupStatusType,
+} from './common.types';
+import { KybZod } from './kyb.types';
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
+import { TypeID } from 'typeid-js';
+import { AddressSchema } from './address.types';
+import { PhoneZodSchema } from './phone.type';
+extendZodWithOpenApi(z);
+
+// importing investorAccountIdSchema directly from './investor-account.types' causes 500 server errors due to circular import
+const investorAccountIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === 'investor_account';
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid investor_account ID format. Must be a valid TypeID with "investor_account" prefix.',
+  },
+);
+
+export const legalEntityIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === 'legal_entity';
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid legal_entity ID format. Must be a valid TypeID with "legal_entity" prefix.',
+  },
+);
+export const LegalEntityZod = IBaseEntity.extend({
+  thirdPartyId: z
+    .string()
+    .openapi({ example: 'third_party_legal_entity_123' })
+    .nullable(),
+  accountId: z
+    .string()
+    .openapi({ example: 'account_01j1xgme5qeqq97gpdztd7e4a6' }),
+  investorAccountId: z
+    .string()
+    .openapi({ example: 'investor_account_01j1xgme5qeqq97gpdztd7e4a7' }),
+  kybStatus: z
+    .lazy(() => z.nativeEnum(KYBStatus))
+    .openapi({ example: 'PENDING' }),
+  sanctionsStatus: z
+    .lazy(() => z.nativeEnum(SanctionsStatus))
+    .openapi({ example: 'PENDING' }),
+  kybs: z.array(KybZod).optional(),
+  name: z.string().openapi({ example: 'Acme Corporation' }),
+  ein: z.string().openapi({ example: '12-3456789' }).nullish(),
+  companyType: z.string().openapi({ example: 'LLC' }).nullish(),
+  streetAddress: z.string().openapi({ example: '123 Main St' }).nullish(),
+  city: z.string().openapi({ example: 'Anytown' }).nullish(),
+  state: z.string().openapi({ example: 'CA' }).nullable(),
+  zip: z.string().openapi({ example: '12345' }).nullish(),
+  country: z.string().openapi({ example: 'USA' }).nullish(),
+  phone: z.string().openapi({ example: '+12124567890' }).nullish(),
+  setupStatus: z.nativeEnum(SetupStatusType),
+});
+export type LegalEntityZod = z.infer<typeof LegalEntityZod>;
+
+export const IPaginatedLegalEntity = z.object({
+  items: z.array(LegalEntityZod),
+  meta: IPaginationMeta,
+});
+export type IPaginatedLegalEntity = z.infer<typeof IPaginatedLegalEntity>;
+
+const legalEntitiesInclude = z.enum(['kybs']);
+
+export const LegalEntityFiltersZod = z.object({
+  kybStatus: z.nativeEnum(KYBStatus).optional(),
+  sanctionsStatus: z.nativeEnum(SanctionsStatus).optional(),
+});
+
+/**
+ * @description Query parameters for including related entities
+ * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
+ */
+export const LegalEntitiesIncludeQuery = z.object({
+  include: z
+    .string()
+    .optional()
+    .transform((str) => (str ? str.split(',') : []))
+    .refine(
+      (includes) =>
+        includes.every((include) =>
+          legalEntitiesInclude.options.includes(include as any),
+        ),
+      {
+        message: `Invalid include option provided. Valid options are: ${legalEntitiesInclude.options.join(',')}`,
+      },
+    )
+    .openapi({
+      example: `${legalEntitiesInclude.options.join(',')}`,
+    }),
+});
+export interface LegalEntitiesIncludeQuery
+  extends z.infer<typeof LegalEntitiesIncludeQuery> {}
+export const EINSchema = z
+  .string()
+  .openapi({ example: '123456789' })
+  .length(9, 'Ein shall be of 9 characters')
+  .refine((v) => !isNaN(Number(v)), {
+    message: `Ein can only consist of numbers`,
+  })
+  .optional();
+
+export const CompanyNameSchema = z
+  .string()
+  .openapi({ example: 'Acme Corporation' })
+  .min(2, 'Name is less than 2 characters ')
+  .max(50, 'Name is more than 50 characters ');
+
+export const CompanyTypeSchema = z
+  .string()
+  .openapi({ example: 'LLC' })
+  .min(2, 'companyType is less than 2 characters ')
+  .max(50, 'companyType is more than 50 characters ');
+
+export const PostLegalEntitySchema = z
+  .object({
+    investorAccountId: investorAccountIdSchema,
+    name: CompanyNameSchema,
+    ein: EINSchema,
+    email: z.string().email().optional(),
+    companyType: CompanyTypeSchema.optional(),
+    phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
+    dateOfIncorporation: z.lazy(() => dateSchema).optional(),
+    stateOfIncorporation: z.string().optional(),
+  })
+  .and(AddressSchema);
+
+export type PostLegalEntityType = z.infer<typeof PostLegalEntitySchema>;
+
+export const UpdateLegalEntitySchema = z
+  .object({
+    id: legalEntityIdSchema.optional(),
+    name: CompanyNameSchema.optional(),
+    ein: EINSchema,
+    email: z.string().email().optional(),
+    companyType: CompanyTypeSchema.optional(),
+    phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
+    dateOfIncorporation: z.lazy(() => dateSchema).optional(),
+    stateOfIncorporation: z.string().optional(),
+  })
+  .and(AddressSchema);
+
+export type UpdateLegalEntityType = z.infer<typeof UpdateLegalEntitySchema>;
+
+export const ResponseLegalEntitySchema = z.object({
+  id: legalEntityIdSchema,
+  accountId: z.string(),
+  investorAccountId: z.string(),
+  name: CompanyNameSchema,
+  ein: EINSchema.nullish(),
+  email: z.string().email().nullable(),
+  companyType: z.string().nullable(),
+  address: z.string().nullable(),
+  address2: z.string().nullable(),
+  city: z.string().nullable(),
+  state: z.string().nullable(),
+  zip: z.string().nullable(),
+  country: z.string().nullable(),
+  phone: z.string().nullable(),
+  dateOfIncorporation: z.coerce.date().nullable(),
+  stateOfIncorporation: z.string().nullable(),
+  setupStatus: z.nativeEnum(SetupStatusType),
+});
+export type ResponseLegalEntityType = z.infer<typeof ResponseLegalEntitySchema>;

package/src/common/types/login-history.types.ts

@@ -0,0 +1,46 @@
+import { TypeID } from 'typeid-js';
+import { z } from 'zod';
+import { IBaseEntity } from './entity.types';
+export const loginHistoryIdSchema = z.string().refine(
+  (value) => {
+    try {
+      const tid = TypeID.fromString(value);
+      return tid.getType() === 'login_history';
+    } catch {
+      return false;
+    }
+  },
+  {
+    message:
+      'Invalid login history ID format. Must be a valid TypeID with "login_history" prefix.',
+  },
+);
+export const ILoginHistory = IBaseEntity.extend({
+  id: loginHistoryIdSchema,
+  ipAddress: z.string().ip().nullable(),
+  location: z.string().nullable(),
+  browser: z.string().nullable(),
+  deviceString: z.string().nullable(),
+  osVersion: z.string().nullable(),
+  browserVersion: z.string().nullable(),
+  os: z.string().nullable(),
+  userId: z.string().nullable(),
+  user: z.any().nullable(),
+});
+export type ILoginHistory = z.infer<typeof ILoginHistory>;
+
+export const PostLoginHistoryZod = z.object({
+  ipAddress: z.string().ip().nullable(),
+  location: z.string().nullable(),
+  browser: z.string().nullable(),
+  deviceString: z.string().nullable(),
+  osVersion: z.string().nullable(),
+  browserVersion: z.string().nullable(),
+  os: z.string().nullable(),
+});
+export type PostLoginHistoryZod = z.infer<typeof PostLoginHistoryZod>;
+
+export const IListLoginHistories = z.object({
+  items: z.array(ILoginHistory),
+});
+export type IListLoginHistories = z.infer<typeof IListLoginHistories>;

package/src/common/types/mail-template.types.ts

@@ -0,0 +1,436 @@
+import { z } from 'zod';
+import { InvestorAccountType } from './common.types';
+
+export const IssuerWelcomeEmailTemplateZod = z.object({
+  issuerName: z.string(),
+});
+export type IssuerWelcomeEmailTemplateZod = z.infer<
+  typeof IssuerWelcomeEmailTemplateZod
+>;
+
+export const ResetPasswordEmailTemplateZod = z.object({
+  name: z.string(),
+  resetPasswordLink: z.string(),
+  resetPasswordCode: z.string(),
+});
+export type ResetPasswordEmailTemplateZod = z.infer<
+  typeof ResetPasswordEmailTemplateZod
+>;
+
+export const InvitationEmailTemplateZod = z.object({
+  issuerName: z.string(),
+  role: z.string(),
+  invitationLink: z.string(),
+});
+export type InvitationEmailTemplateZod = z.infer<
+  typeof InvitationEmailTemplateZod
+>;
+
+export const InvestorWelcomeEmailTemplateZod = z.object({
+  investorName: z.string(),
+  issuerName: z.string(),
+  loginLink: z.string(),
+});
+export type InvestorWelcomeEmailTemplateZod = z.infer<
+  typeof InvestorWelcomeEmailTemplateZod
+>;
+
+export const PlacedOrderLineItemsZod = z.object({
+  name: z.string(),
+  pricePerShare: z.number(),
+  numberOfSharesPurchased: z.number(),
+  totalInvestment: z.number(),
+});
+export type PlacedOrderLineItemsZod = z.infer<typeof PlacedOrderLineItemsZod>;
+
+export const OrderPlacedEmailTemplateZod = z.object({
+  issuerName: z.string(),
+  investorName: z.string(),
+  investorAccountType: z.nativeEnum(InvestorAccountType),
+  lineItems: z.array(PlacedOrderLineItemsZod),
+  tradeDetailsEndpoint: z.string(),
+  isWirePayment: z.boolean(),
+  usAccountHolderName: z.string(),
+  usBankName: z.string(),
+  usRoutingNumber: z.string(),
+  usAccountNumber: z.string(),
+  reference: z.string(),
+  swiftId: z.string(),
+});
+export type OrderPlacedEmailTemplateZod = z.infer<
+  typeof OrderPlacedEmailTemplateZod
+>;
+
+export const OrderApprovedEmailTemplateZod = OrderPlacedEmailTemplateZod.omit({
+  lineItems: true,
+}).extend({
+  pricePerShare: z.number(),
+  numberOfAssetsPurchased: z.number(),
+  name: z.string(),
+  totalAmount: z.number(),
+  isWirePayment: z.boolean(),
+  usAccountHolderName: z.string(),
+  usBankName: z.string(),
+  usRoutingNumber: z.string(),
+  usAccountNumber: z.string(),
+  reference: z.string(),
+  swiftId: z.string(),
+});
+export type OrderApprovedEmailTemplateZod = z.infer<
+  typeof OrderApprovedEmailTemplateZod
+>;
+
+export const TaskAssignedEmailTemplateZod = z.object({
+  userName: z.string(),
+  taskName: z.string(),
+  assignedBy: z.string(),
+  dueDate: z.string(),
+  taskType: z.string(),
+  priority: z.string(),
+  description: z.string(),
+  completeTaskEndpoint: z.string(),
+});
+export type TaskAssignedEmailTemplateZod = z.infer<
+  typeof TaskAssignedEmailTemplateZod
+>;
+export const ResetPasswordSuccessEmailTemplateZod = z.object({
+  name: z.string(),
+  loginLink: z.string(),
+});
+export type ResetPasswordSuccessEmailTemplateZod = z.infer<
+  typeof ResetPasswordSuccessEmailTemplateZod
+>;
+
+export const PaymentFailedEmailTemplateZod = z.object({
+  firstName: z.string(),
+  tradeDetailsEndpoint: z.string(),
+});
+export type PaymentFailedEmailTemplateZod = z.infer<
+  typeof PaymentFailedEmailTemplateZod
+>;
+export const RetirementInstructionEmailTemplateZod = z.object({
+  name: z.string(),
+  instruction: z.string(),
+});
+export type RetirementInstructionEmailTemplateZod = z.infer<
+  typeof RetirementInstructionEmailTemplateZod
+>;
+
+export const ContactUsEmailTemplateZod = z.object({
+  firstName: z.string(),
+  lastName: z.string(),
+  email: z.string(),
+  subject: z.string(),
+  message: z.string(),
+  timestamp: z.string(),
+});
+export type ContactUsEmailTemplateZod = z.infer<
+  typeof ContactUsEmailTemplateZod
+>;
+
+export const SignatureRequestEmailTemplateZod = z.object({
+  investorName: z.string(),
+  requestedBy: z.string(),
+  requestedByEmail: z.string(),
+  documentName: z.string(),
+  expirationDate: z.string(),
+  signersList: z.array(
+    z.object({
+      name: z.string(),
+      email: z.string(),
+    }),
+  ),
+});
+export type SignatureRequestEmailTemplateZod = z.infer<
+  typeof SignatureRequestEmailTemplateZod
+>;
+// TODO: Add EMAIL_VERIFICATION
+export const EMAIL_TEMPLATES = {
+  WELCOME_ISSUER: {
+    subject: 'Welcome to Dalmore',
+    path: 'welcome-issuer.mjml',
+    body: `<html>
+<body>
+    <p>Hello {{issuerName}},</p>
+    
+    <p>Welcome to Dalmore! We're thrilled to have you here as you take the next step in raising investments.</p>
+    
+    <p>Getting started is simple. Complete setting up your issuer account, submit your offering for review, and once approved, you'll be ready to connect with investors.</p>
+    
+    <p>For more details on how Dalmore can support your fundraising efforts, we've attached a brief info guide.</p>
+    
+    <p>If you have any questions, feel free to reach out.</p>
+    
+    <p>Best,<br>
+    The Dalmore Team</p>
+</body>
+</html>`,
+  },
+
+  WELCOME_INVESTOR: {
+    subject: 'Start Investing with {{issuerName}} on Dalmore',
+    path: 'welcome-investor.mjml',
+    body: `<html>
+<body>
+    <p>Hello {{investorName}},</p>
+    
+    <p>{{issuerName}} is now accepting investments on Dalmore. Explore the offering and invest today.</p>
+    
+    <p>You can view the offering here:</p>
+    
+    <p><a href="{{heroAssetLink}}">View Offering</a></p>
+    
+    <p>If you have any questions, we're here to help.</p>
+    
+    <p>Best,<br>
+    The Dalmore Team</p>
+</body>
+</html>`,
+  },
+
+  RESET_PASSWORD: {
+    subject: 'Reset your password',
+    path: 'reset-password.mjml',
+    body: `<html>
+<body>
+    <p>Hello {{name}},</p>
+    
+    <p>We received a request to reset your password. Click below to set a new one:</p>
+
+    <p>Code: {{resetPasswordCode}}</p>
+    
+    <p><a href="{{resetPasswordLink}}">Reset Password</a></p>
+    
+    <p>If you didn't request this, please ignore this email.</p>
+    
+    <p>Best,<br>
+    The Dalmore Team</p>
+</body>
+</html>`,
+  },
+
+  ISSUER_INVITATION: {
+    subject: "You've Been Invited to Join an Issuer Account",
+    path: 'invitation.mjml',
+    body: `<html>
+<body>
+    <p>Hello,</p>
+    
+    <p>You've been invited to join the {{issuerName}}'s account on Dalmore with the role of {{role}}.</p>
+    
+    <p>Click below to accept the invitation and access the account:</p>
+    
+    <p>{{invitationLink}}</p>
+    
+    <p>If you have any questions, feel free to reach out.</p>
+    
+    <p>Best,<br>
+    The Dalmore Team</p>
+</body>
+</html>`,
+  },
+
+  COMPLIANCE_INVITATION: {
+    subject: "You've Been Invited to Join an Compliance Account",
+    path: 'compliance-invitation.mjml',
+    body: `<html>
+<body>
+    <p>Hello,</p>
+    
+    <p>You've been invited to join the Dalmore Group Compliance Portal with the role of {{role}}.</p>
+    
+    <p>Click below to accept the invitation and access the account:</p>
+    
+    <p>{{invitationLink}}</p>
+    
+    <p>If you have any questions, feel free to reach out.</p>
+    
+    <p>Best,<br>
+    The Dalmore Team</p>
+</body>
+</html>`,
+  },
+
+  ORDER_PLACED: {
+    subject: 'Your Trade Has Been Placed',
+    path: 'order-placed.mjml',
+    body: `<html>
+<body>
+    <p>Hello {{investorName}},</p>
+    
+    <p>Your trade has been successfully placed with {{issuerName}}. Here are the details:</p>
+    
+    <p><b>Investor Account Type:</b> {{investorAccountType}}<br>
+    <b>Offering Name:</b> {{offeringName}}<br>
+    <b>Number of Assets Purchased:</b> {{numberOfAssetsPurchased}}<br>
+    <b>Total Investment Value:</b> {{totalInvestmentAmount}}</p>
+    
+    <p>You will receive a confirmation once the order is reviewed.</p>
+    
+    <p><a href="{{tradeDetailsEndpoint}}">View Trade Details</a></p>
+    
+    <p>Best,<br>
+    The Dalmore Team</p>
+</body>
+</html>`,
+  },
+
+  ORDER_APPROVED: {
+    subject: 'Your Trade Has Been Approved',
+    path: 'order-approved.mjml',
+    body: `<html>
+<body>
+    <p>Hello {{investorName}},</p>
+    
+    <p>Your trade with {{issuerName}} has been reviewed and approved. Here are the details:</p>
+    
+    <p><b>Investor Account Type:</b> {{investorAccountType}}<br>
+    <b>Offering Name:</b> {{offeringName}}<br>
+    <b>Number of Assets Purchased:</b> {{numberOfAssetsPurchased}}<br>
+    <b>Total Investment Value:</b> {{totalInvestmentAmount}}</p>
+    
+    <p>You can view your trade details in your account.</p>
+    
+    <p>Best,<br>
+    The Dalmore Team</p>
+</body>
+</html>`,
+  },
+  TASK_ASSIGNED: {
+    subject: 'New Task Assigned',
+    path: 'task-assigned.mjml',
+    body: `<html>
+<body>
+    <p>Hi, {{userName}}!</p>
+    
+    <p>You have a new task assigned to you. Please review the details below:</p>
+    
+    <p>Task Name: {{taskName}}<br>
+    Assigned By: {{assignedBy}}<br>
+    Due Date: {{dueDate}}<br>
+    Task Type: {{taskType}}<br>
+    Priority: {{priority}}<br>
+    Description: {{description}}</p>
+    
+    <p><a href="{{completeTaskEndpoint}}">Complete Task</a></p>
+</body>
+</html>
+`,
+  },
+  AML_PENDING: {
+    subject: 'AML Pending',
+    path: 'aml-pending.mjml',
+    body: `<html>
+<body>
+    <p>Hi, {{userName}}!</p>
+    
+    <p>Your AML status is pending. Please complete your AML.</p>
+    
+    <p>Click below to visit your AML record:</p>
+    
+    <p><a href="{{completeAmlEndpoint}}">Visit AML</a></p>
+</body>
+</html>
+`,
+  },
+  PAYMENT_FAILED: {
+    subject: 'Payment Failed',
+    path: 'payment-failed.mjml',
+    body: ``,
+  },
+  RESET_PASSWORD_SUCCESS: {
+    subject: 'Password Changed Successfully',
+    path: 'reset-password-successful.mjml',
+    body: ``,
+  },
+  RETIREMENT_INSTRUCTION: {
+    subject: 'Retirement Instruction',
+    path: 'retirement-instruction.mjml',
+    body: ``,
+  },
+  EMAIL_NOTIFICATION: {
+    subject: '{{subject}}',
+    path: 'email-notification.mjml',
+    body: ``,
+  },
+  CONTACT_US: {
+    subject: 'New Contact Message',
+    path: 'contact-us.mjml',
+    body: ``,
+  },
+  SUBMIT_PAYMENT: {
+    subject: 'New Task Assigned – Submit Payment',
+    path: 'submit-payment.mjml',
+    body: ``,
+  },
+  SIGNATURE_REQUEST: {
+    subject: 'Document Signature Request',
+    path: 'signature-request.mjml',
+    body: ``,
+  },
+};
+// TODO: Add EMAIL_VERIFICATION
+export enum EmailTemplatesType {
+  WELCOME_ISSUER = 'WELCOME_ISSUER',
+  WELCOME_INVESTOR = 'WELCOME_INVESTOR',
+  RESET_PASSWORD = 'RESET_PASSWORD',
+  RESET_PASSWORD_SUCCESS = 'RESET_PASSWORD_SUCCESS',
+  ISSUER_INVITATION = 'ISSUER_INVITATION',
+  COMPLIANCE_INVITATION = 'COMPLIANCE_INVITATION',
+  EMAIL_NOTIFICATION = 'EMAIL_NOTIFICATION',
+  ORDER_PLACED = 'ORDER_PLACED',
+  ORDER_APPROVED = 'ORDER_APPROVED',
+  TASK_ASSIGNED = 'TASK_ASSIGNED',
+  PAYMENT_FAILED = 'PAYMENT_FAILED',
+  UPDATE_PAYMENT = 'UPDATE_PAYMENT',
+  KYC_VERIFICATION_REQUIRED = 'KYC_VERIFICATION_REQUIRED',
+  DOCUMENT_SIGNATURE_PENDING = 'DOCUMENT_SIGNATURE_PENDING',
+  VERIFY_ACCOUNT = 'VERIFY_ACCOUNT',
+  SIGNATURE_REQUEST = 'SIGNATURE_REQUEST',
+  SUBMIT_PAYMENT = 'SUBMIT_PAYMENT',
+  RETIREMENT_INSTRUCTION = 'RETIREMENT_INSTRUCTION',
+  AML_PENDING = 'AML_PENDING',
+  CONTACT_US = 'CONTACT_US',
+  NONE = 'NONE',
+}
+
+export enum EmailAttachmentsType {
+  USER_MANUAL = 'USER_MANUAL',
+  BROKER_DEALER = 'BROKER_DEALER',
+  STREAM = 'STREAM',
+  STREAMS = 'STREAMS',
+  OTHER = 'OTHER',
+  NONE = 'NONE',
+}
+
+export const FooterZod = z.object({
+  linkedinUrl: z.string().url().nullable(),
+  twitterUrl: z.string().url().nullable(),
+  facebookUrl: z.string().url().nullable(),
+  instagramUrl: z.string().url().nullable(),
+  mailSupporter: z.string().email().nullable(),
+  websiteUrl: z.string().url().nullable(),
+  otherUrls: z.array(z.string().url().nullable()).nullable(),
+  poweredByImageUrl: z.string().url().nullable(),
+  contactUsUrl: z.string().url().nullable(),
+});
+export type FooterZod = z.infer<typeof FooterZod>;
+
+export const HeaderZod = z.object({
+  companyName: z.string(),
+  logoUrl: z.string().nullable(),
+});
+
+export type HeaderZod = z.infer<typeof HeaderZod>;
+
+export const HeaderAndFooterZod = z.object({
+  header: HeaderZod,
+  footer: FooterZod,
+});
+export type HeaderAndFooterZod = z.infer<typeof HeaderAndFooterZod>;
+
+export const EmailThemeSettingZod = z.record(z.string(), z.string().nullable());
+export type EmailThemeSetting = z.infer<typeof EmailThemeSettingZod>;
+
+export const EmailThemeSettingsZod = z.array(EmailThemeSettingZod);
+export type EmailThemeSettingsZod = z.infer<typeof EmailThemeSettingsZod>;