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

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

@@ -1,143 +0,0 @@
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
-import { TypeID } from 'typeid-js';
-import { z } from 'zod';
-import { IBaseEntity } from './entity.types';
-import { accountIdSchema } from './account.types';
-import { IPaginationMeta } from './common.types';
-
-extendZodWithOpenApi(z);
-
-export enum IntegrationType {
-  RAISI = 'RAISI',
-}
-
-export const accountIntegrationIdSchema = z.string().refine(
-  (value) => {
-    try {
-      const tid = TypeID.fromString(value);
-      return tid.getType() === 'account_integration';
-    } catch {
-      return false;
-    }
-  },
-  {
-    message:
-      'Invalid account integration ID format. Must be a valid TypeID with "account_integration" prefix.',
-  },
-);
-
-export const AccountIntegrationZod = IBaseEntity.extend({
-  id: accountIntegrationIdSchema,
-  name: z.string(),
-  integration: z.nativeEnum(IntegrationType),
-  description: z.string().nullable(),
-  partnerId: z.string().nullable(),
-  url: z.string().nullable(),
-  webhook: z.string().nullable(),
-  active: z.boolean(),
-  metadata: z.record(z.string(), z.unknown()).nullable(),
-  accountId: z.lazy(() => accountIdSchema),
-});
-export type AccountIntegrationZod = z.infer<typeof AccountIntegrationZod>;
-
-export const IPaginatedAccountIntegration = z.object({
-  items: z.array(AccountIntegrationZod),
-  meta: IPaginationMeta,
-});
-export type IPaginatedAccountIntegration = z.infer<
-  typeof IPaginatedAccountIntegration
->;
-
-export const PostAccountIntegrationZod = z.object({
-  name: z.string().min(1).max(100).openapi({ example: 'Raisi' }),
-  integration: z
-    .nativeEnum(IntegrationType)
-    .openapi({ example: IntegrationType.RAISI }),
-  description: z
-    .string()
-    .min(1)
-    .max(1000)
-    .nullable()
-    .optional()
-    .openapi({ example: 'Raisi integration' }),
-  partnerId: z
-    .string()
-    .min(1)
-    .max(100)
-    .nullable()
-    .optional()
-    .openapi({ example: '1234567890' }),
-  url: z
-    .string()
-    .url()
-    .nullable()
-    .optional()
-    .openapi({ example: 'https://www.raisi.com' }),
-  webhook: z
-    .string()
-    .url()
-    .nullable()
-    .optional()
-    .openapi({ example: 'https://www.raisi.com/webhook' }),
-  active: z.boolean().default(true).openapi({ example: true }),
-  metadata: z
-    .record(z.string(), z.unknown())
-    .nullable()
-    .optional()
-    .openapi({ example: { key: 'value' } }),
-});
-export type PostAccountIntegrationZod = z.infer<
-  typeof PostAccountIntegrationZod
->;
-
-export const PatchAccountIntegrationZod = z.object({
-  name: z
-    .string()
-    .min(1)
-    .max(100)
-    .nullable()
-    .optional()
-    .openapi({ example: 'Raisi' }),
-  integration: z
-    .nativeEnum(IntegrationType)
-    .optional()
-    .openapi({ example: IntegrationType.RAISI }),
-  description: z
-    .string()
-    .min(1)
-    .max(1000)
-    .nullable()
-    .optional()
-    .openapi({ example: 'Raisi integration' }),
-  partnerId: z.string().min(1).max(100).nullable().optional(),
-  url: z
-    .string()
-    .url()
-    .nullable()
-    .optional()
-    .openapi({ example: 'https://www.raisi.com' }),
-  webhook: z
-    .string()
-    .url()
-    .nullable()
-    .optional()
-    .openapi({ example: 'https://www.raisi.com/webhook' }),
-  active: z.boolean().nullable().optional(),
-  metadata: z
-    .record(z.string(), z.unknown())
-    .nullable()
-    .optional()
-    .openapi({ example: { key: 'value' } }),
-});
-export type PatchAccountIntegrationZod = z.infer<
-  typeof PatchAccountIntegrationZod
->;
-
-export const AccountIntegrationFiltersZod = z.object({
-  search: z.string().max(50).optional(),
-  integration: z.nativeEnum(IntegrationType).optional(),
-  active: z.boolean().optional(),
-});
-export type AccountIntegrationFiltersZod = z.infer<
-  typeof AccountIntegrationFiltersZod
->;

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

@@ -1,124 +0,0 @@
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
-import { z } from 'zod';
-import { TypeID } from 'typeid-js';
-import { IBaseEntity } from './entity.types';
-import { PhoneNumberData } from './sms.types';
-import { userIdSchema, UserZod } from './user.types';
-import { IPaginationMeta } from './common.types';
-import { PhoneZodSchema } from './phone.type';
-
-extendZodWithOpenApi(z);
-export const accountManagerIdSchema = z.string().refine(
-  (value) => {
-    try {
-      const tid = TypeID.fromString(value);
-      return tid.getType() === 'account_manager';
-    } catch {
-      return false;
-    }
-  },
-  {
-    message: `Invalid account manager ID format. Must be a valid TypeID with "account_manager" prefix. Example: account_manager_01j5y5ghx5fg68d663j1fvy2x7`,
-  },
-);
-
-export const accountManagersInclude = z.enum(['accounts', 'user']);
-
-/**
- * @description Query parameters for including related entities
- * @xample in contract us as -> query: z.object({}).merge(AccountManagersIncludeQuery),
- */
-export const AccountManagersIncludeQuery = z.object({
-  include: z
-    .string()
-    .optional()
-    .transform((str) => (str ? str.split(',') : []))
-    .refine(
-      (includes) =>
-        includes.every((include) =>
-          accountManagersInclude.options.includes(include as any),
-        ),
-      {
-        message: `Invalid include option provided. Valid options are: ${accountManagersInclude.options.join(',')}`,
-      },
-    )
-    .openapi({
-      example: `${accountManagersInclude.options.join(',')}`,
-    }),
-});
-
-export const IAccountManagerZod = IBaseEntity.extend({
-  firstName: z.string().openapi({ example: 'John' }),
-  lastName: z.string().openapi({ example: 'Doe' }),
-  email: z.string().email().openapi({ example: 'john.doe@example.com' }),
-  phone: PhoneNumberData.nullable().openapi({ example: '+12124567890' }),
-  isDefault: z.boolean().openapi({ example: false }),
-  userId: z
-    .lazy(() => userIdSchema)
-    .nullable()
-    .openapi({ example: 'user_01je6ht4b8fbmttkzh2hs82xqp' }),
-  user: z
-    .lazy(() => UserZod)
-    .optional()
-    .nullable(),
-});
-
-export type IAccountManagerZod = z.infer<typeof IAccountManagerZod>;
-
-export const PostAccountManagerZod = 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' }),
-  phone: PhoneZodSchema.nullable()
-    .optional()
-    .openapi({ example: '+12124567890' }),
-  isDefault: z.boolean().openapi({ example: false }),
-});
-
-export type PostAccountManagerZod = z.infer<typeof PostAccountManagerZod>;
-
-export const PatchAccountManagerZod = z.object({
-  firstName: z.string().min(1).max(255).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' }),
-  phone: PhoneZodSchema.nullable()
-    .optional()
-    .openapi({ example: '+12124567890' }),
-  isDefault: z.boolean().optional().openapi({ example: false }),
-});
-export type PatchAccountManagerZod = z.infer<typeof PatchAccountManagerZod>;
-
-export const IPaginatedAccountManager = z.object({
-  items: z.array(IAccountManagerZod),
-  meta: IPaginationMeta,
-});
-export type IPaginatedAccountManager = z.infer<typeof IPaginatedAccountManager>;
-
-export const AccountManagerDeleteResponse = z.object({
-  status: z.boolean().openapi({ example: true }),
-});
-export type AccountManagerDeleteResponse = z.infer<
-  typeof AccountManagerDeleteResponse
->;
-export const SetDefaultAccountManagerForAllAccountsResponse = z.object({
-  message: z
-    .string()
-    .openapi({ example: 'Default account manager set for all accounts' }),
-});
-export type SetDefaultAccountManagerForAllAccountsResponse = z.infer<
-  typeof SetDefaultAccountManagerForAllAccountsResponse
->;
-
-export const AccountManagerDeleteQuery = z.object({
-  reassignTo: accountManagerIdSchema
-    .nullable()
-    .optional()
-    .openapi({ example: 'account_manager_01j5y5ghx5fg68d663j1fvy2x7' }),
-});
-export type AccountManagerDeleteQuery = z.infer<
-  typeof AccountManagerDeleteQuery
->;

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

@@ -1,65 +0,0 @@
-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

@@ -1,297 +0,0 @@
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
-import { TypeID } from 'typeid-js';
-import { z } from 'zod';
-import {
-  AccountZod,
-  dateSchema,
-  IPaginationMeta,
-  IssuerOnboardingSetupType,
-  ManagedByType,
-  Platform,
-  SortBy,
-  SortOrder,
-  AccountStatus,
-} from './common.types';
-import { notionPageIdSchema } from './notion-page.types';
-
-extendZodWithOpenApi(z);
-
-export const accountIdSchema = z.string().refine(
-  (value) => {
-    try {
-      const tid = TypeID.fromString(value);
-      return tid.getType() === 'account';
-    } catch {
-      return false;
-    }
-  },
-  {
-    message:
-      'Invalid account ID format. Must be a valid TypeID with "account" prefix.',
-  },
-);
-
-export const UpdateAccountZod = z.object({
-  name: z.string().min(1).max(100),
-  status: z.nativeEnum(AccountStatus).optional(),
-  platform: z
-    .nativeEnum(Platform)
-    .optional()
-    .openapi({ example: Platform.INTEGRATION }),
-  managedBy: z
-    .nativeEnum(ManagedByType)
-    .optional()
-    .openapi({ example: ManagedByType.DALMORE }),
-  approversCount: z.number().min(1).max(5).optional(),
-});
-export type UpdateAccountZod = z.infer<typeof UpdateAccountZod>;
-
-export const CreateAccountZod = z.object({
-  name: z.string().min(1).max(100).openapi({ example: 'Name' }),
-  platform: z
-    .nativeEnum(Platform)
-    .optional()
-    .openapi({ example: Platform.INTEGRATION }),
-  managedBy: z
-    .nativeEnum(ManagedByType)
-    .optional()
-    .openapi({ example: ManagedByType.DALMORE }),
-  approversCount: z.number().min(1).max(5).optional().openapi({ example: 2 }),
-  hubspotCompany: z
-    .string()
-    .url()
-    .max(2048)
-    .nullable()
-    .optional()
-    .openapi({ example: 'https://www.google.com' }),
-});
-export type CreateAccountZod = z.infer<typeof CreateAccountZod>;
-
-export const IPaginatedAccount = z.object({
-  items: z.array(AccountZod),
-  meta: IPaginationMeta,
-});
-export type IPaginatedAccount = z.infer<typeof IPaginatedAccount>;
-
-export const AccountFiltersZod = z.object({
-  search: z.string().max(50).optional(),
-  status: z.nativeEnum(AccountStatus).optional(),
-  platform: z
-    .nativeEnum(Platform)
-    .optional()
-    .openapi({ example: Platform.INTEGRATION }),
-  managedBy: z
-    .nativeEnum(ManagedByType)
-    .optional()
-    .openapi({ example: ManagedByType.DALMORE }),
-  from: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
-  to: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
-});
-
-const accountsInclude = z.enum([
-  'accountManager',
-  'accountIntegrations',
-  'accountSettings',
-  'apiKeys',
-  'assets',
-  'dataRooms',
-  'individuals',
-  'investorAccounts',
-  'invites',
-  'issuers',
-  'legalEntities',
-  'offerings',
-  'sites',
-  'trades',
-  'users',
-]);
-
-/**
- * @description Query parameters for including related entities
- * @xample in contract us as -> query: z.object({}).merge(AccountsIncludeQuery),
- */
-export const AccountsIncludeQuery = z.object({
-  include: z
-    .string()
-    .optional()
-    .transform((str) => (str ? str.split(',') : []))
-    .refine(
-      (includes) =>
-        includes.every((include) =>
-          accountsInclude.options.includes(include as any),
-        ),
-      {
-        message: `Invalid include option provided. Valid options are: ${accountsInclude.options.join(',')}`,
-      },
-    )
-    .openapi({
-      example: `${accountsInclude.options.join(',')}`,
-    }),
-});
-export interface AccountsIncludeQuery
-  extends z.infer<typeof AccountsIncludeQuery> {}
-
-export const PatchAccountZod = z.object({
-  name: z.string().min(1).max(100),
-  approversCount: z.number().min(1).max(5).optional(),
-  managedBy: z.nativeEnum(ManagedByType).optional(),
-  platform: z.nativeEnum(Platform).optional(),
-  integrationGuideId: notionPageIdSchema.nullable().optional(),
-  productPrimaries: z.boolean().optional(),
-  productSecondaries: z.boolean().optional(),
-  featureDisbursements: z.boolean().optional(),
-});
-export type PatchAccountZod = z.infer<typeof PatchAccountZod>;
-
-export const CompliancePatchAccountZod = PatchAccountZod.extend({
-  hubspotCompany: z
-    .string()
-    .url()
-    .max(2048)
-    .nullable()
-    .optional()
-    .openapi({ example: 'https://www.google.com' }),
-});
-export type CompliancePatchAccountZod = z.infer<
-  typeof CompliancePatchAccountZod
->;
-
-export const PostAccountResponse = z.object({
-  id: z.string(),
-});
-export type PostAccountResponse = z.infer<typeof PostAccountResponse>;
-
-export const GetAccountIssuersZod = z.object({
-  name: z.string().optional(),
-  accountId: accountIdSchema.optional(),
-});
-export type GetAccountIssuersZod = z.infer<typeof GetAccountIssuersZod>;
-
-export const UpdateAccountIssuersStatusZod = z.object({
-  status: z.nativeEnum(AccountStatus),
-});
-export type UpdateAccountIssuersStatusZod = z.infer<
-  typeof UpdateAccountIssuersStatusZod
->;
-
-export const UpdateAccountStatusReponse = z.object({
-  id: accountIdSchema,
-  status: z.nativeEnum(AccountStatus),
-});
-export type UpdateAccountStatusReponse = z.infer<
-  typeof UpdateAccountStatusReponse
->;
-
-export const AccountsSummaryFilterZod = z.object({
-  search: z.string().trim().max(50).optional(),
-  status: z.nativeEnum(AccountStatus).optional(),
-  from: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
-  to: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
-  accountManagerIds: z
-    .string()
-    .optional()
-    .transform((val) => {
-      if (!val || typeof val !== 'string') return undefined;
-
-      const ids = val
-        .split(',')
-        .map((id: string) => id.trim())
-        .filter((id: string) => id.length > 0);
-
-      // Remove duplicates using Set
-      const uniqueIds = [...new Set(ids)];
-
-      return uniqueIds.length > 0 ? uniqueIds : undefined;
-    })
-    .pipe(
-      z
-        .array(
-          z.string().refine(
-            (value) => {
-              try {
-                const tid = TypeID.fromString(value);
-                return tid.getType() === 'account_manager';
-              } catch {
-                return false;
-              }
-            },
-            {
-              message: `Invalid account manager ID format. Must be a valid TypeID with "account_manager" prefix. Example: account_manager_01j5y5ghx5fg68d663j1fvy2x7`,
-            },
-          ),
-        )
-        .optional(),
-    ),
-});
-export type AccountsSummaryFilterZod = z.infer<typeof AccountsSummaryFilterZod>;
-
-export const AccountSortZod = z.object({
-  sort: z.enum([SortBy.NAME, SortBy.CREATED_AT, SortBy.UPDATED_AT]).optional(),
-  dir: z.nativeEnum(SortOrder).optional(),
-});
-export type AccountSortZod = z.infer<typeof AccountSortZod>;
-
-export const AccountsSummaryZod = z.object({
-  accountId: accountIdSchema,
-  accountName: z.string(),
-  issuers: z.number().int(),
-  offerings: z.number().int(),
-  assets: z.number().int(),
-  users: z.number().int(),
-  trades: z.number().int(),
-  accountManagerName: z.string(),
-  createdOn: z.string(),
-  status: z.string(),
-});
-export type AccountsSummaryZod = z.infer<typeof AccountsSummaryZod>;
-
-export const IPaginatedAccountsSummaryResponse = z.object({
-  items: z.array(AccountsSummaryZod),
-  meta: IPaginationMeta,
-});
-export type IPaginatedAccountsSummaryResponse = z.infer<
-  typeof IPaginatedAccountsSummaryResponse
->;
-export const PatchIssuerOnboardingStep = z.object({
-  step: z.nativeEnum(IssuerOnboardingSetupType),
-});
-export type PatchIssuerOnboardingStep = z.infer<
-  typeof PatchIssuerOnboardingStep
->;
-
-export const IssuerOnboardingStepZod = z.object({
-  offeringSetup: z.boolean().default(false),
-  investorPortalSetup: z.boolean().default(false),
-  paymentMethodSetup: z.boolean().default(false),
-  accountContactsSetup: z.boolean().default(false),
-});
-export type IssuerOnboardingStepZod = z.infer<typeof IssuerOnboardingStepZod>;
-
-export const OnboardingAccountSummaryZod = z.object({
-  accountId: accountIdSchema,
-  accountName: z.string(),
-  siteId: z.string().nullable(),
-  offeringId: z.string().nullable(),
-  investorPortalSetup: z.boolean(),
-  offeringSetup: z.boolean(),
-  paymentMethodSetup: z.boolean(),
-  accountContactsSetup: z.boolean(),
-});
-export type OnboardingAccountSummaryZod = z.infer<
-  typeof OnboardingAccountSummaryZod
->;
-
-export const IPaginatedOnboardingAccountSummaryResponse = z.object({
-  items: z.array(OnboardingAccountSummaryZod),
-  meta: IPaginationMeta,
-});
-export type IPaginatedOnboardingAccountSummaryResponse = z.infer<
-  typeof IPaginatedOnboardingAccountSummaryResponse
->;
-
-export const OnboardingAccountSummaryFilterZod = z.object({
-  status: z.nativeEnum(AccountStatus).optional(),
-});
-export type OnboardingAccountSummaryFilterZod = z.infer<
-  typeof OnboardingAccountSummaryFilterZod
->;