@levrbet/shared 0.1.2 → 0.1.4

package/README.md

@@ -1,114 +1,133 @@
-# levr-shared
+# @levrbet/shared
 
-Contains shared packages, libraries and utilities for Levr's microservices. This code is meant to be reused by other applications, so ensure strict compliance with TypeScript standards.
+Shared utilities, components, and types for the LEVR platform. This package provides core blockchain utilities, server-side tools, and React components in a single, well-organized library.
 
-## Packages
+## 🚀 Quick Start
 
-There are two main packages available:
+### For React Applications
 
-- **@levrbet/shared-core**: Contains core utilities and code that can be used in any JavaScript/TypeScript environment, including browsers and server-side applications.
-- **@levrbet/shared-server**: Contains server-specific utilities and code intended for Node.js runtime environments.
+```bash
+npm install @levrbet/shared react
+```
 
-## Setup
+```typescript
+import { e18, LevrBaseMarket } from "@levrbet/shared/core"
+import { /* React components */ } from "@levrbet/shared/react"
+```
 
-Install new dependencies appropriately. Dev dependencies should be installed as such (`yarn add -D prettier`). The recommended package manager is yarn.
+### For Node.js/Server Applications
 
-1. Install existing dependencies with `yarn install`.
+```bash
+npm install @levrbet/shared
+```
 
-## 📦 Installation
+```typescript
+import { e18, LevrBaseMarket } from "@levrbet/shared/core"
+import { authMiddleWare, validateApiKey } from "@levrbet/shared/server"
+```
 
-To install a package in your project, use one of the following commands:
+## 📦 Package Structure
 
-**Using npm:**
+### Core (`@levrbet/shared/core`)
 
-```bash
-npm install @levrbet/shared-core
-npm install @levrbet/shared-server
-```
+**Universal utilities** - Works in both browser and server environments.
+
+- Blockchain contracts and ABIs
+- Type definitions
+- Utility functions
+- Validation helpers
+
+**Minimal dependencies:** Only essential packages like `viem`, `zod`, `ms`
+
+### React (`@levrbet/shared/react`)
+
+**React-specific utilities** - For React applications only.
+
+- React components
+- Custom hooks
+- Context providers
+
+**Requires:** `react >=18`
+
+### Server (`@levrbet/shared/server`)
 
-**Using yarn:**
+**Server-only utilities** - For Node.js/server environments only.
+
+- Authentication middleware
+- Database utilities (Prisma)
+- Redis caching
+- Logging and observability
+- Express middleware
+
+**Dependencies included:** All server dependencies are bundled - no manual installation needed!
+
+## 🔧 Advanced Installation
+
+### Core Only (no server/React features)
+
+For applications that only need blockchain utilities and types:
 
 ```bash
-yarn add @levrbet/shared-core
-yarn add @levrbet/shared-server
+npm install @levrbet/shared
+# Only core dependencies will be installed
 ```
 
-This will add the selected package to your `package.json` and install it in your `node_modules`.
+## 💡 Why This Approach?
 
-## 📦 Usage
+This package bundles server dependencies for the best developer experience:
 
-To use a package in your project, import it as follows:
+- ✅ **React apps** - Only install React as peer dependency
+- ✅ **Server apps** - Single `npm install` gets everything
+- ✅ **No dependency hell** - All server dependencies work together
+- ✅ **Version compatibility** - Pre-tested dependency combinations
 
-**For core utilities (browser or server):**
+### Bundle Size Considerations
 
-```typescript
-import { someFunction } from "@levrbet/shared-core"
-```
+- **React apps**: Only get core utilities (~lightweight)
+- **Server apps**: Get full functionality with managed dependencies
+- **Tree-shaking**: Unused modules are eliminated in your final bundle
 
-**For server-specific utilities (Node.js):**
+## 🏗️ Development Setup
 
-```typescript
-import { serverFunction } from "@levrbet/shared-server"
-```
+1. **Install dependencies:**
 
-## Setting up pre-commit hooks
+   ```bash
+   bun install
+   ```
 
-1. **Install Python (if not already installed)**  
-   - Download and install Python 3.11+ from [python.org/downloads](https://www.python.org/downloads/).  
-   - Make sure to check **"Add Python to PATH"** during installation on Windows.
+2. **Build the package:**
 
-2. **Create a virtual environment using VS Code (recommended)**  
-   - Open the project folder in VS Code.  
-   - Open the Command Palette (**Ctrl + Shift + P** or **Cmd + Shift + P** on macOS).  
-   - Search for **"Python: Create Environment"** → select **Venv** → select **Python 3.x** → choose **requirements.txt** (if present) or skip package selection.  
-   - VS Code will automatically create and activate a `.venv` folder for this project.
+   ```bash
+   bun run build
+   ```
 
-3. **Install pre-commit in the virtual environment**  
-   - Open a terminal inside VS Code (it should show `.venv` active).  
-   - Run:
+3. **Clean build artifacts:**
 
-     ```bash
-     pip install -r requirements.txt
-     ```
+   ```bash
+   bun run clean
+   ```
 
-4. **Verify the hook installation**  
-   - Run:
+## 🔒 Pre-commit Hooks Setup
 
-     ```bash
-     pre-commit run --all-files
-     ```
+1. **Install Python 3.11+** from [python.org/downloads](https://www.python.org/downloads/)
 
-   - This will check your entire codebase with the configured hooks. If everything works, you’re ready to commit safely!
+2. **Create virtual environment in VS Code:**
+   - Open Command Palette (**Ctrl + Shift + P**)
+   - Select **"Python: Create Environment"** → **Venv** → **Python 3.x**
+   - Choose **requirements.txt** if prompted
 
-5. **Managing .secrets.baseline**
-We use [detect-secrets](https://github.com/Yelp/detect-secrets) to prevent committing API keys, tokens, or other sensitive data.
-   What is `.secrets.baseline`?
-   It's a snapshot of potential secrets already present in the repository.
-   Pre-commit will not fail on these existing entries but will block any new secrets.
-   This file must be kept under version control so the whole team uses the same baseline.
-   When do you need to generate or update it?
-   If the repo already contains .secrets.baseline:
-   Just pull it. Pre-commit will automatically use it. No extra work needed.
-   If setting up from scratch (first time only):
+3. **Install pre-commit:**
 
    ```bash
-   detect-secrets scan > .secrets.baseline
-   detect-secrets audit .secrets.baseline
-   git add .secrets.baseline
-   git commit -m "chore(security): add detect-secrets baseline"
+   pip install -r requirements.txt
    ```
 
-   To update when code changes significantly:
+4. **Verify setup:**
 
    ```bash
-   detect-secrets scan --baseline .secrets.baseline
-   detect-secrets audit .secrets.baseline
-   git add .secrets.baseline
-   git commit -m "chore(security): update detect-secrets baseline"
+   pre-commit run --all-files
    ```
 
-6. **Team rules for .secrets.baseline**
-   - Never delete it — it's required to keep secret scanning consistent.
-   - Do not mark real secrets as safe — rotate/remove secrets instead.
-   - Review all baseline changes in PRs — treat them like code.
-   - Pre-commit will block new secrets automatically — fix or rotate them before committing.
+## 📝 License
+
+This project is proprietary to LEVR Labs.

package/dist/server/index.d.ts

@@ -1,8 +1,8 @@
+export * from "../core";
 export * from "./auth";
 export * from "./config";
 export * from "./contracts";
+export * from "./liquidation-engine";
 export * from "./logging";
 export * from "./oracle";
-export * from "./liquidation-engine";
 export * from "./utils";
-export * from "../core";

package/dist/server/index.js

@@ -14,14 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../core"), exports);
 __exportStar(require("./auth"), exports);
 __exportStar(require("./config"), exports);
 __exportStar(require("./contracts"), exports);
+__exportStar(require("./liquidation-engine"), exports);
 __exportStar(require("./logging"), exports);
 __exportStar(require("./oracle"), exports);
-__exportStar(require("./liquidation-engine"), exports);
 __exportStar(require("./utils"), exports);
-__exportStar(require("../core"), exports);
 // export { sdk } from "./instrumentation"
 // export { sdk as instrumentation } from "./instrumentation"
 //# sourceMappingURL=index.js.map

package/dist/server/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,2CAAwB;AACxB,8CAA2B;AAC3B,4CAAyB;AACzB,2CAAwB;AACxB,uDAAoC;AACpC,0CAAuB;AACvB,0CAAuB;AAEvB,0CAA0C;AAC1C,6DAA6D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,yCAAsB;AACtB,2CAAwB;AACxB,8CAA2B;AAC3B,uDAAoC;AACpC,4CAAyB;AACzB,2CAAwB;AACxB,0CAAuB;AAEvB,0CAA0C;AAC1C,6DAA6D"}