@dalmore/api-contracts 0.0.0-dev.0800e07

package/README.md

@@ -0,0 +1,83 @@
+# @dalmore/api-contracts
+
+Type-safe API contracts for Dalmore Client Portal, powered by [ts-rest](https://ts-rest.com/).
+
+## Installation
+
+```bash
+# Production (stable releases from main branch)
+npm install @dalmore/api-contracts
+
+# Development (latest from dev branch)
+npm install @dalmore/api-contracts@dev
+```
+
+## Usage
+
+### Import from main entry
+
+```typescript
+import { clientsContract } from '@dalmore/api-contracts';
+import type { IInvestorAccount } from '@dalmore/api-contracts';
+```
+
+### Import specific subpaths (recommended for tree-shaking)
+
+```typescript
+// Import clients contract
+import { clientsContract } from '@dalmore/api-contracts/clients';
+
+// Import types
+import type { IInvestorAccount, ITrade } from '@dalmore/api-contracts/types';
+```
+
+### Create a typed client
+
+```typescript
+import { clientsContract } from '@dalmore/api-contracts/clients';
+import { initClient } from '@ts-rest/core';
+
+const client = initClient(clientsContract, {
+  baseUrl: 'https://platform.dalmoregroup.com',
+  baseHeaders: {
+    'X-API-Key': `${apiKey}`,
+  },
+});
+
+// Fully typed API calls
+const { status, body } = await client.accounts.getAccounts({
+  query: { page: 1, limit: 10 },
+});
+```
+
+## Peer Dependencies
+
+This package requires the following peer dependencies:
+
+- `@anatine/zod-openapi` ^1.14.2
+- `@ts-rest/core` ^3.52.1
+- `typeid-js` ^1.2.0
+- `zod` ^3.24.4
+
+## Available Exports
+
+- `clientsContract` - Client API (API key auth)
+
+## Available Subpath Exports
+
+- `@dalmore/api-contracts` - Main entry (clients contract and types)
+- `@dalmore/api-contracts/clients` - Clients contract
+- `@dalmore/api-contracts/types` - All common types
+
+## TypeScript Configuration
+
+This package ships TypeScript source files for maximum type safety. Your `tsconfig.json` should include:
+
+```json
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "esModuleInterop": true
+  }
+}
+```

package/common/helpers/index.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Contract helpers - minimal subset for API documentation generation and type validation
+ */
+type CurlOptions = {
+    query?: Record<string, string>;
+    headers?: Record<string, string>;
+    body?: Record<string, unknown>;
+    formData?: Record<string, string>;
+};
+export declare const authHeader: CurlOptions['headers'];
+export declare const generateApiDescription: (summary: string, method: string, path: string, options: CurlOptions) => string;
+/**
+ * Normalizes a short date string to MM/DD/YYYY format.
+ * @param input - Date string in M/D/YY or M/D/YYYY format
+ * @returns Normalized date string in MM/DD/YYYY format
+ */
+export declare function normalizeShortDate(input: string): string;
+/**
+ * Normalizes a phone number. This is a stub implementation for type checking.
+ * In the actual implementation, this uses libphonenumber-js and returns a Result type.
+ * @param phoneNumber - The phone number to normalize
+ * @param countryCode - The country code
+ * @returns A Result type (stub for contracts package)
+ */
+export declare function normalizePhoneNumber(phoneNumber: string, _countryCode: string): {
+    isOk: () => boolean;
+    isErr: () => boolean;
+    value?: any;
+    error?: any;
+};
+/**
+ * Validates a US zip code format.
+ * @param zipCode - The zip code to validate
+ * @returns true if valid US zip code format (12345 or 12345-6789)
+ */
+export declare const validateUSZipCode: (zipCode: string) => boolean;
+/**
+ * Validates a Canadian zip code format.
+ * @param zipCode - The zip code to validate
+ * @returns true if valid Canadian zip code format (A1A 1A1)
+ */
+export declare const validateCanadaZipCode: (zipCode: string) => boolean;
+/**
+ * Converts a string into a slug suitable for URLs or identifiers.
+ * @param input - The string to be converted into a slug
+ * @param exclude - If true, excludes certain words and replaces reserved words
+ * @returns The generated slug
+ */
+export declare function slugify(input: string, exclude?: boolean): string;
+export {};

package/common/helpers/index.js

@@ -0,0 +1,136 @@
+/**
+ * Contract helpers - minimal subset for API documentation generation and type validation
+ */
+export const authHeader = {
+    Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
+};
+const generateCurlExample = (method, path, options) => {
+    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, method, path, options) => {
+    const curlExample = generateCurlExample(method, path, options);
+    return `${summary}
+
+### Example curl request
+
+\`\`\`bash
+${curlExample}
+\`\`\``;
+};
+/**
+ * Normalizes a short date string to MM/DD/YYYY format.
+ * @param input - Date string in M/D/YY or M/D/YYYY format
+ * @returns Normalized date string in MM/DD/YYYY format
+ */
+export function normalizeShortDate(input) {
+    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}`;
+}
+/**
+ * Normalizes a phone number. This is a stub implementation for type checking.
+ * In the actual implementation, this uses libphonenumber-js and returns a Result type.
+ * @param phoneNumber - The phone number to normalize
+ * @param countryCode - The country code
+ * @returns A Result type (stub for contracts package)
+ */
+export function normalizePhoneNumber(phoneNumber, _countryCode) {
+    // Stub implementation for type checking only
+    // Actual implementation requires libphonenumber-js
+    return {
+        isOk: () => true,
+        isErr: () => false,
+        value: phoneNumber,
+    };
+}
+/**
+ * Validates a US zip code format.
+ * @param zipCode - The zip code to validate
+ * @returns true if valid US zip code format (12345 or 12345-6789)
+ */
+export const validateUSZipCode = (zipCode) => {
+    const regex = /^[0-9]{5}(?:-[0-9]{4})?$/;
+    return regex.test(zipCode);
+};
+/**
+ * Validates a Canadian zip code format.
+ * @param zipCode - The zip code to validate
+ * @returns true if valid Canadian zip code format (A1A 1A1)
+ */
+export const validateCanadaZipCode = (zipCode) => {
+    const regex = /^[A-Za-z]\d[A-Za-z] \d[A-Za-z]\d$/;
+    return regex.test(zipCode);
+};
+/**
+ * Converts a string into a slug suitable for URLs or identifiers.
+ * @param input - The string to be converted into a slug
+ * @param exclude - If true, excludes certain words and replaces reserved words
+ * @returns The generated slug
+ */
+export function slugify(input, exclude = false) {
+    if (exclude) {
+        const excludeWords = ['llc', 'inc', 'corp', 'co'];
+        const negativeWordsList = [
+            'www', 'api', 'admin', 'dashboard', 'auth', 'cdn', 'static', 'blog',
+            'support', 'status', 'mail', 'files', 'media', 'assets',
+            'secure', 'login', 'signin', 'signup', 'logout', 'test', 'staging',
+            'dev', 'verify', 'reset', 'config',
+            'terms', 'tos', 'privacy', 'legal', 'compliance', 'security',
+            'about', 'home', 'contact', 'news', 'team', 'press',
+            'root', 'moderator', 'help', 'cloud', 'shop', 'store', 'app', 'admin-panel',
+            'default', 'null', 'undefined', 'unknown', 'error', 'system', 'superuser',
+            'testing', 'stage', 'development', 'preview',
+        ];
+        if (negativeWordsList.includes(input.toLowerCase())) {
+            input = 'new account';
+        }
+        else {
+            const words = input.split(' ');
+            input = words
+                .filter((word) => !excludeWords.includes(word.toLowerCase()))
+                .join(' ');
+            if (input.trim() === '') {
+                input = 'new account';
+            }
+            if (input
+                .split(' ')
+                .some((word) => negativeWordsList.includes(word.toLowerCase()))) {
+                input = 'new account';
+            }
+        }
+    }
+    return input
+        .trim()
+        .toLowerCase()
+        .replace(/[^a-z0-9\s-]/g, '')
+        .replace(/\s+/g, '-')
+        .replace(/-+/g, '-')
+        .replace(/^-|-$/g, '');
+}
+//# sourceMappingURL=index.js.map

package/common/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;GAEG;AASH,MAAM,CAAC,MAAM,UAAU,GAA2B;IAChD,aAAa,EAAE,6CAA6C;CAC7D,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAC1B,MAAc,EACd,IAAY,EACZ,OAAoB,EACpB,EAAE;IACF,MAAM,OAAO,GAAG,4DAA4D,CAAC;IAC7E,IAAI,IAAI,GAAG,WAAW,MAAM,CAAC,WAAW,EAAE,KAAK,OAAO,GAAG,IAAI,EAAE,CAAC;IAChE,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;QAClE,IAAI,IAAI,IAAI,WAAW,EAAE,CAAC;IAC5B,CAAC;IACD,IAAI,IAAI,GAAG,CAAC;IACZ,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACvD,IAAI,IAAI,oBAAoB,GAAG,KAAK,KAAK,GAAG,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,IAAI,IAAI,kDAAkD,CAAC;QAC3D,IAAI,IAAI,kBAAkB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;IAC5D,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACxD,IAAI,IAAI,kBAAkB,GAAG,IAAI,KAAK,GAAG,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAe,EACf,MAAc,EACd,IAAY,EACZ,OAAoB,EACpB,EAAE;IACF,MAAM,WAAW,GAAG,mBAAmB,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/D,OAAO,GAAG,OAAO;;;;;EAKjB,WAAW;OACN,CAAC;AACR,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE5C,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAExD,OAAO,GAAG,WAAW,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;AACnD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,WAAmB,EACnB,YAAoB;IAEpB,6CAA6C;IAC7C,mDAAmD;IACnD,OAAO;QACL,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI;QAChB,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK;QAClB,KAAK,EAAE,WAAW;KACnB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAW,EAAE;IAC5D,MAAM,KAAK,GAAG,0BAA0B,CAAC;IACzC,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAW,EAAE;IAChE,MAAM,KAAK,GAAG,mCAAmC,CAAC;IAClD,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa,EAAE,UAAmB,KAAK;IAC7D,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAClD,MAAM,iBAAiB,GAAG;YACxB,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM;YACnE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ;YACvD,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS;YAClE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ;YAClC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU;YAC5D,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO;YACnD,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa;YAC3E,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW;YACzE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS;SAC7C,CAAC;QAEF,IAAI,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACpD,KAAK,GAAG,aAAa,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/B,KAAK,GAAG,KAAK;iBACV,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;iBAC5D,IAAI,CAAC,GAAG,CAAC,CAAC;YAEb,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACxB,KAAK,GAAG,aAAa,CAAC;YACxB,CAAC;YAED,IACE,KAAK;iBACF,KAAK,CAAC,GAAG,CAAC;iBACV,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,EACjE,CAAC;gBACD,KAAK,GAAG,aAAa,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK;SACT,IAAI,EAAE;SACN,WAAW,EAAE;SACb,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;SAC5B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC3B,CAAC"}