@dalmore/api-contracts 1.0.9 → 1.0.10

package/src/common/types/contract-helpers.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 './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/files.types.spec.ts

@@ -1,154 +0,0 @@
-import { typeid } from 'typeid-js';
-import {
-  FileZod,
-  allowedFileExtension,
-  fileIdSchema,
-  PostFileQueryParams,
-  FileFilters,
-  ADFFileProcessingPipeline,
-} from './file.types';
-import { FileLabels, FileStatus } from './common.types';
-
-describe('File Validation', () => {
-  describe('fileIdSchema', () => {
-    it('should validate correct file IDs', () => {
-      const validFileId = typeid('file').toString();
-      const result = fileIdSchema.safeParse(validFileId);
-      expect(result.success).toBe(true);
-    });
-
-    it('should reject invalid file IDs', () => {
-      const invalidFileIds = [
-        'user_01j5y5ghx8fvc83dmx3pznq7hv',
-        'file_invalid',
-        '',
-      ];
-
-      invalidFileIds.forEach((id) => {
-        const result = fileIdSchema.safeParse(id);
-        expect(result.success).toBe(false);
-      });
-    });
-  });
-
-  describe('FileZod', () => {
-    it('should validate a correct file object', () => {
-      const validFile = {
-        id: typeid('file').toString(),
-        tid: 'some-tid',
-        url: 'https://example.com/file.pdf',
-        fileType: 'pdf',
-        fileName: 'test.pdf',
-        name: 'test',
-        category: 'application',
-        label: FileLabels.OTHER,
-        metadata: null,
-        private: false,
-        complianceReview: 'PENDING',
-        targetTable: 'TRADES',
-        targetId: null,
-        linkedFrom: null,
-        accountId: typeid('account').toString(),
-        userId: typeid('user').toString(),
-        status: FileStatus.PENDING,
-        pipeline: ADFFileProcessingPipeline.NONE,
-        errorMessage: null,
-        reviewLog: null,
-        createdAt: new Date(),
-        updatedAt: new Date(),
-        deletedAt: null,
-      };
-
-      const result = FileZod.safeParse(validFile);
-      expect(result.success).toBe(true);
-    });
-
-    it('should reject invalid file objects', () => {
-      const invalidFile = {
-        id: 'invalid_id',
-        url: 'not-a-url',
-        // missing required fields
-      };
-
-      const result = FileZod.safeParse(invalidFile);
-      expect(result.success).toBe(false);
-    });
-  });
-
-  describe('PostFileQueryParams', () => {
-    it('should validate correct query parameters', () => {
-      const validQuery = {
-        name: 'test_file',
-        category: 'application',
-        label: FileLabels.OTHER,
-        targetId: typeid('trade').toString(),
-      };
-
-      const result = PostFileQueryParams.safeParse(validQuery);
-      expect(result.success).toBe(true);
-    });
-
-    it('should reject invalid target IDs', () => {
-      const invalidQuery = {
-        name: 'test_file',
-        category: 'application',
-        label: FileLabels.OTHER,
-        targetId: 'invalid_id',
-      };
-
-      const result = PostFileQueryParams.safeParse(invalidQuery);
-      expect(result.success).toBe(false);
-    });
-  });
-
-  describe('FileFilters', () => {
-    it('should handle optional includeLinkedFrom parameter', () => {
-      const validFilters = [
-        { includeLinkedFrom: 'true' },
-        { includeLinkedFrom: 'false' },
-        { includeLinkedFrom: undefined },
-        {},
-      ];
-
-      validFilters.forEach((filter) => {
-        const result = FileFilters.safeParse(filter);
-        expect(result.success).toBe(true);
-      });
-    });
-
-    it('should reject invalid includeLinkedFrom values', () => {
-      const invalidFilters = [
-        { includeLinkedFrom: 'yes' },
-        { includeLinkedFrom: '1' },
-        { includeLinkedFrom: 'TRUE' },
-      ];
-
-      invalidFilters.forEach((filter) => {
-        const result = FileFilters.safeParse(filter);
-        expect(result.success).toBe(false);
-      });
-    });
-  });
-
-  describe('allowedFileExtension', () => {
-    it('should contain all supported extensions', () => {
-      const expectedExtensions = [
-        '.pdf',
-        '.doc',
-        '.docx',
-        '.xls',
-        '.xlsx',
-        '.csv',
-        '.gif',
-        '.png',
-        '.jpg',
-        '.jpeg',
-        '.txt',
-      ];
-
-      expectedExtensions.forEach((ext) => {
-        expect(allowedFileExtension).toContain(ext);
-      });
-    });
-  });
-});