@ratesspot/types

Shared TypeScript type definitions for RatesSpot API and client applications.

Installation

npm install @ratesspot/types
# or
yarn add @ratesspot/types

Usage

In Frontend Application

import {
  Merchant,
  CurrentUserResponse,
  ApiResponse
} from '@ratesspot/types';

// Use with your API client
class ApiClient {
  async getMerchant(): Promise<ApiResponse<Merchant>> {
    return this.request<Merchant>('/api/merchants');
  }

  async getCurrentUser(): Promise<ApiResponse<CurrentUserResponse>> {
    return this.request<CurrentUserResponse>('/api/auth/me');
  }
}

In Backend Application

import {
  CurrentUserResponse,
  CreateMerchantDto
} from '@ratesspot/types';

export const getCurrentUser = async (
  req: Request,
  res: Response
): Promise<void> => {
  const user: CurrentUserResponse = await getUserDetails(req.user.id);
  res.json({ success: true, data: user });
};

Available Types

Auth Types

• CurrentUserResponse - User profile with merchant associations
• MerchantInfo - Merchant information for user
• JWTPayload - JWT token payload structure
• ApiKeyPayload - API key payload
• CreateApiKeyData - API key creation DTO
• UpdateApiKeyData - API key update DTO

API Types

• ApiResponse<T> - Standard API response wrapper
• PaginationMeta - Pagination metadata
• PaginatedRequest - Pagination request parameters

Merchant Types

• Merchant - Complete merchant entity
• CreateMerchantDto - Merchant creation DTO
• UpdateMerchantDto - Merchant update DTO

Development

To add new types:

1. Add type definitions to appropriate file in src/
2. Export from the file
3. Ensure it's exported from src/index.ts
4. Run npm run build to compile
5. Publish new version

Publishing

npm version patch|minor|major
npm publish