@dalmore/api-contracts 1.0.3 → 1.0.5

package/src/common/helpers/index.ts

@@ -1,205 +0,0 @@
-/**
- * Contract helpers - minimal subset for API contracts package
- * This file is copied directly to @dalmore/api-contracts
- */
-import { HttpStatus } from '@nestjs/common';
-import parsePhoneNumberFromString, {
-  CountryCode,
-  PhoneNumber,
-} from 'libphonenumber-js';
-import { err, ok, Result } from 'neverthrow';
-import { ErrorResult } from '../types/common.types';
-
-/**
- * Validates a US zip code format (12345 or 12345-6789)
- */
-export const validateUSZipCode = (zipCode: string): boolean => {
-  const regex = /^[0-9]{5}(?:-[0-9]{4})?$/;
-  return regex.test(zipCode);
-};
-
-/**
- * Validates a Canadian postal code format (A1A 1A1)
- */
-export const validateCanadaZipCode = (zipCode: string): boolean => {
-  const regex = /^[A-Za-z]\d[A-Za-z] \d[A-Za-z]\d$/;
-  return regex.test(zipCode);
-};
-
-/**
- * Normalizes a short date string (M/D/YY or M/D/YYYY) to MM/DD/YYYY format
- */
-export function normalizeShortDate(input: string): string {
-  const [month, day, year] = input.split('/');
-
-  if (!month || !day || !year) {
-    throw new Error('Invalid date format');
-  }
-
-  const paddedMonth = month.padStart(2, '0');
-  const paddedDay = day.padStart(2, '0');
-  const fullYear = year.length === 2 ? `20${year}` : year;
-
-  return `${paddedMonth}/${paddedDay}/${fullYear}`;
-}
-
-/**
- * Converts a string into a URL-safe slug
- */
-export function slugify(input: string, exclude: boolean = false): string {
-  if (exclude) {
-    const excludeWords = ['llc', 'inc', 'corp', 'co'];
-    const negativeWordsList = [
-      'www',
-      'api',
-      'admin',
-      'dashboard',
-      'auth',
-      'cdn',
-      'static',
-      'blog',
-      'support',
-      'status',
-      'mail',
-      'smtp',
-      'ftp',
-      'ssh',
-      'login',
-      'register',
-      'signup',
-      'account',
-      'accounts',
-      'user',
-      'users',
-      'profile',
-      'settings',
-      'help',
-      'docs',
-      'documentation',
-      'developer',
-      'developers',
-      'app',
-      'apps',
-      'test',
-      'demo',
-      'staging',
-      'dev',
-      'prod',
-      'production',
-      'beta',
-      'alpha',
-      'portal',
-      'portals',
-      'client',
-      'clients',
-      'investor',
-      'investors',
-      'issuer',
-      'issuers',
-      'compliance',
-      'offering',
-      'offerings',
-      'trade',
-      'trades',
-    ];
-
-    let slug = input
-      .toLowerCase()
-      .replace(/[^\w\s-]/g, '')
-      .replace(/[\s_-]+/g, '-')
-      .replace(/^-+|-+$/g, '');
-
-    excludeWords.forEach((word) => {
-      slug = slug.replace(new RegExp(`-${word}$`, 'i'), '');
-    });
-
-    if (negativeWordsList.includes(slug)) {
-      return 'new-account';
-    }
-
-    return slug;
-  }
-
-  return input
-    .toLowerCase()
-    .replace(/[^\w\s-]/g, '')
-    .replace(/[\s_-]+/g, '-')
-    .replace(/^-+|-+$/g, '');
-}
-
-type CurlOptions = {
-  query?: Record<string, string>;
-  headers?: Record<string, string>;
-  body?: Record<string, unknown>;
-  formData?: Record<string, string>;
-};
-
-export const authHeader: CurlOptions['headers'] = {
-  Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
-};
-
-const generateCurlExample = (
-  method: string,
-  path: string,
-  options: CurlOptions,
-) => {
-  const baseUrl = 'https://dalmore-client-portal-api-prod.onrender.com/api/v1';
-  let curl = `curl -X ${method.toUpperCase()} '${baseUrl}${path}`;
-  if (options.query) {
-    const queryString = new URLSearchParams(options.query).toString();
-    curl += `?${queryString}`;
-  }
-  curl += "'";
-  if (options.headers) {
-    Object.entries(options.headers).forEach(([key, value]) => {
-      curl += ` \\\n  --header '${key}: ${value}'`;
-    });
-  }
-  if (options.body) {
-    curl += ` \\\n  --header 'Content-Type: application/json'`;
-    curl += ` \\\n  --data '${JSON.stringify(options.body)}'`;
-  }
-  if (options.formData) {
-    Object.entries(options.formData).forEach(([key, value]) => {
-      curl += ` \\\n  --form '${key}=${value}'`;
-    });
-  }
-  return curl;
-};
-
-export const generateApiDescription = (
-  summary: string,
-  method: string,
-  path: string,
-  options: CurlOptions,
-) => {
-  const curlExample = generateCurlExample(method, path, options);
-  return `${summary}
-
-### Example curl request
-
-\`\`\`bash
-${curlExample}
-\`\`\``;
-};
-
-/**
- * Normalizes a phone number to E.164 format
- */
-export function normalizePhoneNumber(
-  phoneNumber: string,
-  countryCode: CountryCode,
-): Result<PhoneNumber, ErrorResult> {
-  const parsedPhoneNumber = parsePhoneNumberFromString(
-    phoneNumber,
-    countryCode,
-  );
-
-  if (!parsedPhoneNumber || !parsedPhoneNumber.isValid()) {
-    return err({
-      status: HttpStatus.BAD_REQUEST,
-      message: 'Invalid phone number. Only numbers',
-    });
-  }
-  return ok(parsedPhoneNumber);
-}

package/src/common/types/account-contact.types.ts

@@ -1,98 +0,0 @@
-import { extendZodWithOpenApi } from '@anatine/zod-openapi';
-import { TypeID } from 'typeid-js';
-import { z } from 'zod';
-import { accountIdSchema } from './account.types';
-import { PhoneZodSchema } from './phone.type';
-import {
-  AccountContactType,
-  AccountZod,
-  IPaginationMeta,
-} from './common.types';
-import { IBaseEntity } from './entity.types';
-import { PhoneNumberData } from './sms.types';
-
-extendZodWithOpenApi(z);
-
-export const accountContactIdSchema = z.string().refine(
-  (value) => {
-    try {
-      const tid = TypeID.fromString(value);
-      return tid.getType() === 'account_contact';
-    } catch {
-      return false;
-    }
-  },
-  {
-    message:
-      'Invalid account contact ID format. Must be a valid TypeID with "account_contact" prefix.',
-  },
-);
-
-export const IAccountContact = IBaseEntity.extend({
-  id: accountContactIdSchema,
-  title: z.string().nullable().openapi({ example: 'Mr' }),
-  firstName: z.string().nullable().openapi({ example: 'John' }),
-  lastName: z.string().nullable().openapi({ example: 'Doe' }),
-  email: z
-    .string()
-    .email()
-    .nullable()
-    .openapi({ example: 'john.doe@example.com' }),
-  phone: PhoneNumberData.nullable().optional().openapi({ example: null }),
-  type: z
-    .nativeEnum(AccountContactType)
-    .openapi({ example: AccountContactType.GENERAL }),
-  accountId: accountIdSchema.openapi({
-    example: 'account_01je6ht4b8fbmttkzh2hs82xqp',
-  }),
-  account: AccountZod.optional().nullable(),
-  referenceLink: z.string().nullable().optional(),
-});
-export type IAccountContact = z.infer<typeof IAccountContact>;
-
-export const PatchAccountContactZod = z.object({
-  title: z
-    .string()
-    .min(1)
-    .max(50)
-    .nullable()
-    .optional()
-    .openapi({ example: 'Mr' }),
-  firstName: z.string().min(1).max(150).openapi({ example: 'John' }),
-  lastName: z.string().min(1).max(150).openapi({ example: 'Doe' }),
-  email: z.string().email().openapi({ example: 'john.doe@example.com' }),
-  phone: PhoneZodSchema.nullable()
-    .optional()
-    .openapi({ example: '+12124567890' }),
-});
-
-export type PatchAccountContactZod = z.infer<typeof PatchAccountContactZod>;
-
-export const CompliancePatchAccountContactZod = PatchAccountContactZod.extend({
-  accountId: accountIdSchema.openapi({
-    example: 'account_01je6ht4b8fbmttkzh2hs82xqp',
-  }),
-  referenceLink: z
-    .string()
-    .url()
-    .max(2048)
-    .nullable()
-    .optional()
-    .openapi({ example: 'https://www.google.com' }),
-});
-export type CompliancePatchAccountContactZod = z.infer<
-  typeof CompliancePatchAccountContactZod
->;
-
-export const IPaginatedAccountContact = z.object({
-  items: z.array(IAccountContact),
-  meta: IPaginationMeta,
-});
-export type IPaginatedAccountContact = z.infer<typeof IPaginatedAccountContact>;
-
-export const AccountContactDeleteResponse = z.object({
-  status: z.enum(['pass', 'fail']),
-});
-export type AccountContactDeleteResponse = z.infer<
-  typeof AccountContactDeleteResponse
->;

package/src/common/types/account-detail.types.ts

@@ -1,27 +0,0 @@
-import { z } from 'zod';
-import { IAsset } from './asset.types';
-import { IIssuer } from './issuer.types';
-import { IOffering } from './offering.types';
-import { IIssuerPaymentMethod } from './issuer-payment-method.types';
-import { SiteZod } from './site.types';
-import { IPage } from './page.types';
-
-export const AccountDetailSummaryZod = z.object({
-  id: z.string(),
-  name: z.string(),
-  issuers: z.array(
-    IIssuer.extend({
-      offerings: z.lazy(() =>
-        z.array(
-          IOffering.extend({
-            assets: z.lazy(() => z.array(IAsset)),
-          }),
-        ),
-      ),
-      paymentMethods: z.lazy(() => z.array(IIssuerPaymentMethod)),
-    }),
-  ),
-  sites: z.lazy(() => z.array(SiteZod)),
-  pages: z.lazy(() => z.array(IPage)),
-});
-export type AccountDetailSummaryZod = z.infer<typeof AccountDetailSummaryZod>;

package/src/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/src/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
->;