@dalmore/api-contracts 1.0.1 → 1.0.3

package/src/common/helpers/index.ts

@@ -0,0 +1,205 @@
+/**
+ * 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/{common → src/common}/types/batch-jobs.types.ts

@@ -5,7 +5,6 @@ import { dateSchema, IPaginationMeta, UserRole } from './common.types';
 import { userIdSchema } from './user.types';
 import { accountIdSchema } from './account.types';
 import { IBaseEntity } from './entity.types';
-import { JobsOptions } from 'bullmq';
 
 extendZodWithOpenApi(z);
 

package/{common → src/common}/types/common.types.ts

@@ -4,7 +4,7 @@ import { z } from 'zod';
 import { TypeID } from 'typeid-js';
 import { ErrorHttpStatusCode } from '@ts-rest/core';
 import { TwoFactorMethod } from './sms.types';
-import { normalizeShortDate } from '../helpers';
+import { normalizeShortDate } from './contract-helpers';
 import { HttpStatus } from '@nestjs/common';
 
 extendZodWithOpenApi(z);

package/src/common/types/contract-helpers.ts

@@ -0,0 +1,205 @@
+/**
+ * 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 './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/{common → src/common}/types/page.types.ts

@@ -14,7 +14,7 @@ import {
   UrlSchema,
 } from './common.types';
 import { accountIdSchema } from './account.types';
-import { slugify } from '../helpers';
+import { slugify } from './contract-helpers';
 import { fileIdSchema } from './file.types';
 
 extendZodWithOpenApi(z);

package/{common → src/common}/types/queue.types.ts

@@ -1,4 +1,3 @@
-import { JobsOptions } from 'bullmq';
 import { typeid } from 'typeid-js';
 
 export enum QueueFrequency {

package/{common → src/common}/types/trade.types.ts

@@ -53,8 +53,10 @@ import {
   SecondaryTrade,
   SecondaryTradeFiltersZod,
 } from './secondary-trade.types';
-import { InvestorAccount } from '../../investor-accounts/entities/investor-account.entity';
-import { Trade } from '../../trades/entities/trade.entity';
+
+// Stub types for backend entities (not included in contracts package)
+type InvestorAccount = Record<string, unknown>;
+type Trade = Record<string, unknown>;
 
 extendZodWithOpenApi(z);
 export const CheckResultsSchema = z.object({

package/{common → src/common}/types/zip.type.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { validateCanadaZipCode, validateUSZipCode } from '../helpers';
+import { validateCanadaZipCode, validateUSZipCode } from './contract-helpers';
 import { CountryCode, CountryEnumSchema } from './countries.types';
 
 export function refineAddressZip(