nhandan-souvernir-be

A tRPC server for the Nhandan Souvenir application with MongoDB integration, providing type-safe API endpoints for History, Order, and Tracking entities.

Installation

npm install nhandan-souvernir-be

Configuration

Create a .env file in your project root with the following variables:

MONGODB_URI=mongodb://username:password@host1:27017,host2:27017,host3:27017/database-name?authSource=admin&replicaSet=rs0
PORT=3033

Usage

Starting the Server

// Import and start the server
import 'nhandan-souvernir-be';

Using Types and Schemas in Your Client

import type { AppRouter } from 'nhandan-souvernir-be';
import { createOrderSchema, historyFilterSchema } from 'nhandan-souvernir-be';
import { createTRPCProxyClient, httpBatchLink } from '@trpc/client';

// Create a tRPC client
const trpc = createTRPCProxyClient<AppRouter>({
  links: [
    httpBatchLink({
      url: 'http://localhost:3033',
    }),
  ],
});

// Use the client to interact with the API
async function fetchOrders() {
  const orders = await trpc.order.getAll.query({
    pagination: {
      page: 1,
      limit: 10
    }
  });
  
  console.log(orders);
}

Available API Endpoints

History Endpoints

• history.create - Create a new history record
• history.getAll - Get all history records with pagination and filtering
• history.getById - Get a single history record by ID
• history.update - Update a history record
• history.delete - Delete a history record

Order Endpoints

• order.create - Create a new order
• order.getAll - Get all orders with pagination and filtering
• order.getById - Get a single order by ID
• order.getByOrderId - Get an order by order_id
• order.update - Update an order
• order.delete - Delete an order

Tracking Endpoints

• tracking.create - Create a new tracking record
• tracking.getAll - Get all tracking records with pagination and filtering
• tracking.getById - Get a single tracking record by ID
• tracking.getByOrderId - Get tracking records by order_id
• tracking.update - Update a tracking record
• tracking.delete - Delete a tracking record

License

ISC