@dalmore/api-contracts 0.0.0-dev.2dc8e92 → 1.0.1

package/common/helpers/index.ts

@@ -1,6 +1,14 @@
 /**
- * Contract helpers - minimal subset for API documentation generation
+ * 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';
 
 type CurlOptions = {
   query?: Record<string, string>;
@@ -57,3 +65,24 @@ export const generateApiDescription = (
 ${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/types/contract-helpers.ts

@@ -0,0 +1,88 @@
+/**
+ * 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';
+
+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/types/phone.type.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { normalizePhoneNumber } from '../helpers';
+import { normalizePhoneNumber } from './contract-helpers';
 import { CountryCodes } from './countries.types';
 import { CountryCode } from 'libphonenumber-js';
 import { ok } from 'neverthrow';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dalmore/api-contracts",
-  "version": "0.0.0-dev.2dc8e92",
+  "version": "1.0.1",
   "description": "Type-safe API contracts for Dalmore Client Portal",
   "main": "./contracts/index.ts",
   "types": "./contracts/index.ts",
@@ -40,6 +40,10 @@
     "./types/*": {
       "types": "./common/types/*.ts",
       "default": "./common/types/*.ts"
+    },
+    "./helpers": {
+      "types": "./common/helpers/index.ts",
+      "default": "./common/helpers/index.ts"
     }
   },
   "files": [
@@ -64,7 +68,10 @@
   },
   "peerDependencies": {
     "@anatine/zod-openapi": "^1.14.2",
+    "@nestjs/common": "^11.0.0",
     "@ts-rest/core": "^3.52.1",
+    "libphonenumber-js": "^1.12.0",
+    "neverthrow": "^8.0.0",
     "typeid-js": "^1.2.0",
     "zod": "^3.24.4"
   },
@@ -74,4 +81,4 @@
   "engines": {
     "node": ">=24.0.0 <25.0.0"
   }
-}
+}