@buiducnhat/ritel-sdk 0.2.0 → 0.2.1

package/README.md

@@ -1,21 +1,21 @@
-# @ritel/sdk
+# @buiducnhat/ritel-sdk
 
 TypeScript SDK for Ritel Mini ERP external APIs.
 
 ## Installation
 
 ```bash
-npm install @ritel/sdk
+npm install @buiducnhat/ritel-sdk
 # or
-bun add @ritel/sdk
+bun add @buiducnhat/ritel-sdk
 # or
-pnpm add @ritel/sdk
+pnpm add @buiducnhat/ritel-sdk
 ```
 
 ## Quick Start
 
 ```typescript
-import { RitelClient } from "@ritel/sdk";
+import { RitelClient } from "@buiducnhat/ritel-sdk";
 
 const client = new RitelClient({
   baseUrl: "https://your-ritel-server.com",
@@ -32,9 +32,7 @@ const products = await client.products.list({
 const order = await client.orders.create({
   customerName: "John Doe",
   customerPhone: "+84901234567",
-  items: [
-    { productId: "prod_123", quantity: 2, unitPrice: 50000 },
-  ],
+  items: [{ productId: "prod_123", quantity: 2, unitPrice: 50000 }],
   paymentMethod: "bank_transfer",
 });
 
@@ -79,6 +77,57 @@ const response = await client.products.list({
 }
 ```
 
+#### `client.products.get(id)`
+
+Get a single product by ID.
+
+```typescript
+const product = await client.products.get("prod_123");
+
+// Product interface
+{
+  id: string;
+  name: string;
+  sku: string | null;
+  salePrice: number;
+  currentSalePrice: number | null;  // Discounted price if applicable
+  imageUrl: string | null;
+  description: string | null;
+  unit: string | null;              // e.g., "pcs", "kg"
+  category: { id: string; name: string } | null;
+  customProperties: Record<string, unknown> | null;
+  stockQuantity: number;
+}
+```
+
+### Categories
+
+#### `client.categories.list(params?)`
+
+List product categories with optional filters.
+
+```typescript
+const response = await client.categories.list({
+  limit: 20,        // Pagination limit
+  offset: 0,        // Pagination offset
+  search: "cloth",  // Search by name
+});
+
+// Response
+{
+  data: Category[],
+  pagination: { total, limit, offset, hasMore }
+}
+
+// Category interface
+{
+  id: string;
+  name: string;
+  slug: string;
+  description: string | null;
+}
+```
+
 ### Orders
 
 #### `client.orders.create(input)`
@@ -99,7 +148,20 @@ const order = await client.orders.create({
   expectedDeliveryDate: "2024-01-20", // Optional
 });
 
-// Response includes vietQrUrl for bank_transfer
+// Response includes vietQrUrl and bankInfo for bank_transfer
+{
+  id: string;
+  orderNumber: string;
+  total: number;
+  paymentMethod: string;
+  paymentStatus: string;
+  vietQrUrl: string | null;       // QR code URL for payment
+  bankInfo: {                     // Bank details for manual transfer
+    bankBin: string | null;
+    bankAccountNumber: string | null;
+    bankAccountName: string | null;
+  } | null;
+}
 ```
 
 #### `client.orders.list(params?)`
@@ -110,9 +172,9 @@ List orders with optional filters.
 const response = await client.orders.list({
   limit: 20,
   offset: 0,
-  status: "pending",        // "pending" | "completed" | "cancelled"
+  status: "pending", // "pending" | "completed" | "cancelled"
   paymentStatus: "pending", // "pending" | "paid" | "failed"
-  orderNumber: "ORD-001",   // Exact match
+  orderNumber: "ORD-001", // Exact match
 });
 ```
 
@@ -150,7 +212,11 @@ const order = await client.orders.cancel("order_abc123");
 ## Error Handling
 
 ```typescript
-import { RitelApiError, RitelNetworkError } from "@ritel/sdk";
+import {
+  RitelApiError,
+  RitelNetworkError,
+  RitelError,
+} from "@buiducnhat/ritel-sdk";
 
 try {
   await client.orders.create(input);
@@ -172,12 +238,42 @@ All types are exported:
 
 ```typescript
 import type {
+  // Client config
+  RitelClientConfig,
+
+  // Products
   Product,
+  ProductCategory,
+  GetProductsParams,
+  ProductsListResponse,
+
+  // Categories
+  Category,
+  GetCategoriesParams,
+  CategoriesListResponse,
+
+  // Orders
   Order,
+  OrderItem,
+  OrderItemInput,
   CreateOrderInput,
-  GetProductsParams,
-  // ... more
-} from "@ritel/sdk";
+  UpdateOrderInput,
+  ListOrdersParams,
+  OrderCreateResponse,
+  OrdersListResponse,
+  DeliveryInfo,
+
+  // Common
+  Pagination,
+  ApiErrorResponse,
+} from "@buiducnhat/ritel-sdk";
+
+// Resource classes (for advanced usage)
+import {
+  ProductsResource,
+  CategoriesResource,
+  OrdersResource,
+} from "@buiducnhat/ritel-sdk";
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buiducnhat/ritel-sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript SDK for Ritel Mini ERP external APIs",
   "type": "module",
   "main": "./dist/index.cjs",