@temboplus/tembo-dashboard 0.2.0 → 0.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TemboPlus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,130 +1,84 @@
 # @temboplus/tembo-dashboard
 
-A foundational library for Temboplus-Dashboard projects providing type-safe data layer abstraction with API contracts, domain models, and repositories.
+Type-safe client library for the TemboPlus Dashboard API. Repository classes wrap each resource (collections, payouts, auth, …) so consumers never talk to HTTP directly.
 
-## Features
+## Quick Start
 
-- **Type Safety**: Full TypeScript support with Zod schema validation
-- **API Contracts**: Type-safe API definitions using `@ts-rest/core`
-- **Domain Models**: Rich business logic with proper data handling
-- **Query Builders**: Fluent API for building complex queries
-- **Repository Pattern**: Clean data access layer with error handling
-
-## Modules
-
-### Collections
-Handle incoming payments from mobile money and bank channels.
-
-```typescript
-import { CollectionRepository } from '@temboplus/tembo-dashboard';
-
-const repo = new CollectionRepository();
-const collections = await repo.getCollections();
-const summary = await repo.getSummary();
-```
-
-### Payouts
-Manage outbound payments to mobile money and bank accounts.
-
-```typescript
-import { PayoutRepository } from '@temboplus/tembo-dashboard';
-
-const repo = new PayoutRepository();
-const payouts = await repo.getPayouts();
-const payout = await repo.getPayout('id');
+```bash
+bun add @temboplus/tembo-dashboard
+# or: npm install @temboplus/tembo-dashboard
 ```
 
-### Authentication
-User authentication and session management.
-
 ```typescript
-import { AuthRepository } from '@temboplus/tembo-dashboard';
-
-const repo = new AuthRepository();
-const user = await repo.login({
-  identity: 'user@example.com',
-  password: 'password'
-});
-```
-
-## Architecture
+import { AuthRepository, PayoutRepository } from "@temboplus/tembo-dashboard";
 
-Each module follows a consistent pattern:
+// 1. Log in. The returned User contains the token.
+const authRepo = new AuthRepository();
+const user = await authRepo.login({ identity: "user@example.com", password: "password" });
 
-```
-module/
-├── module.dtos.ts          # Zod schemas and types
-├── module.api-contract.ts  # API contract definitions
-├── module.model.ts         # Domain models with business logic
-├── module.query-builder.ts # Query building utilities
-└── module.repository.ts    # Data access layer
+// 2. Pass the token to any other repository.
+const payoutRepo = new PayoutRepository({ token: user.token });
+const payouts = await payoutRepo.getPayouts({ page: 1, limit: 10 });
 ```
 
 ## Usage
 
-### Installation
-
-```bash
-npm install @temboplus/tembo-dashboard
-```
-
-The library has peer dependencies that need to be installed:
+Authenticated repositories share the same construction shape:
 
-```bash
-npm install @temboplus/frontend-core @ts-rest/core zod tslib uuid
+```typescript
+const repo = new SomeRepository({
+  token: "user-auth-token",
+  root: "https://api.example.com", // optional override
+});
 ```
 
-### Basic Setup
+Available repositories:
 
-```typescript
-import { PayoutRepository } from '@temboplus/tembo-dashboard';
-
-// Initialize with optional config
-const payoutRepo = new PayoutRepository({
-  token: 'your-auth-token',
-  root: 'https://api.example.com'
-});
+- `AuthRepository` — login, session management
+- `CollectionRepository` — inbound payments (mobile money + bank)
+- `PayoutRepository` — outbound payments
 
-// Use the repository
-const result = await payoutRepo.getPayouts({
-  page: 1,
-  limit: 10,
-  status: 'PAYMENT_ACCEPTED'
-});
-```
+### Query builders
 
-### Query Building
+Fluent builders for common filter shapes:
 
 ```typescript
-import { PayoutQueryBuilder } from '@temboplus/tembo-dashboard';
+import { PayoutQueryBuilder } from "@temboplus/tembo-dashboard";
 
 const query = new PayoutQueryBuilder()
   .whereSuccessful()
   .whereAmountBetween(1000, 50000)
-  .dateRange('2024-01-01', '2024-12-31')
+  .dateRange("2024-01-01", "2024-12-31")
   .toPayoutQuery();
 
 const payouts = await repo.getPayouts(query);
 ```
 
-## Requirements
+## Consumed By
+
+- **TemboPlus Dashboard** (Next.js frontend) — internal merchant-facing dashboard.
 
-- TypeScript 4.5+
-- Node.js 16+
+## Development
 
-## Peer Dependencies
+Bun for everything, Biome for lint+format, mise for the toolchain pin.
 
-- `@temboplus/frontend-core ^0.2.11` - Core utilities and Amount handling
-- `@ts-rest/core ^3.52.1` - API contract definitions
-- `zod ^3.24.2` - Schema validation
-- `tslib ^2.8.1` - TypeScript runtime helpers
-- `uuid ^11.1.0` - UUID generation
+```bash
+mise install        # one-time: installs pinned Bun
+bun install
+bun run dev         # rollup build in watch mode
+```
 
-## Repository
+| Script | Does |
+| --- | --- |
+| `bun run dev` | Rollup build in watch mode |
+| `bun run build` | Rollup build + `tsc-alias` declaration rewrite to `dist/` |
+| `bun run test` | `bun:test` (passes with zero tests; smoke test only) |
+| `bun run lint` | Biome check |
+| `bun run format` | Biome auto-fix |
+| `bun run typecheck` | `tsc --noEmit` |
 
-- **GitHub**: [tembo-dashboard-js](https://github.com/TemboPlus-Frontend/tembo-dashboard-js)
-- **Issues**: [Report issues](https://github.com/TemboPlus-Frontend/tembo-dashboard-js/issues)
+Tag-driven releases via `.github/workflows/release.yml` — update `CHANGELOG.md`, bump `package.json`, push a `vX.Y.Z` tag.
 
 ## License
 
-TemboPlus © 2025
+[MIT](./LICENSE) © TemboPlus