klaim 1.6.0 → 1.6.2

package/Makefile

@@ -1,14 +1,39 @@
-dev:
-	nr dev
-
-dev-test:
-	cd ../klaim-test && nr dev
-
-update-version-deno:
-	@echo "Extracting version from package.json..."
-	@VERSION=$(shell grep -oP '"version":\s*"\K[^"]+' package.json) && \
-	echo "Found version: $$VERSION" && \
-	echo "Updating deno.json..." && \
-	sed -i.bak 's/"version": "[^"]*"/"version": "'$$VERSION'"/' deno.json && \
-	rm deno.json.bak && \
-	echo "Update completed successfully!"
+dev:
+	nr dev
+
+dev-test:
+	cd ../klaim-test && nr dev
+
+update-version-deno:
+	@echo "Extracting version from package.json..."
+	@VERSION=$(shell grep -oP '"version":\s*"\K[^"]+' package.json) && \
+	echo "Found version: $$VERSION" && \
+	echo "Updating deno.json..." && \
+	sed -i.bak 's/"version": "[^"]*"/"version": "'$$VERSION'"/' deno.json && \
+	rm deno.json.bak && \
+	echo "Update completed successfully!"
+
+.PHONY: release release-minor release-major
+
+release:
+	( \
+		eval `ssh-agent -s`; \
+		ssh-add ~/.ssh/id_rsa; \
+		nr release; \
+	)
+
+release-minor:
+	( \
+		eval `ssh-agent -s`; \
+		ssh-add ~/.ssh/id_rsa; \
+		nr release:minor; \
+	)
+
+release-major:
+	( \
+		eval `ssh-agent -s`; \
+		ssh-add ~/.ssh/id_rsa; \
+		nr release:major; \
+	)
+
+

package/README.md

@@ -1,262 +1,262 @@
-## 📚 Table of Contents
-
-- [Features](#-features)
-- [Installation](#-installation)
-- [Usage](#-usage)
-    - [Basic API Configuration](#basic-api-configuration)
-    - [Route Definition](#route-definition)
-    - [Request Handling](#request-handling)
-    - [Middleware Usage](#middleware-usage)
-    - [Hook Subscription](#hook-subscription)
-    - [Caching Requests](#caching-requests)
-    - [Retry Mechanism](#retry-mechanism)
-    - [Response Validation](#response-validation)
-- [Links](#-links)
-- [Contributing](#-contributing)
-- [License](#-license)
-
-## 🚀 Features
-
-- **Efficient API Management**: Easily manage multiple APIs with streamlined integration and interaction capabilities.
-- **Request Recording**: Seamlessly track requests for debugging and monitoring.
-- **User Experience Optimization**: Focused on performance and usability for a smooth user experience.
-- **Lightweight**: Minimal footprint for fast load times and minimal performance impact.
-- **Middleware Support**: Easily add middleware to modify requests and responses (`before` and `after`).
-- **Hook System**: Subscribe to hooks to monitor and react to specific events.
-- **Caching**: Enable caching on requests to reduce network load and improve performance.
-- **Retry Mechanism**: Automatically retry failed requests to enhance reliability.
-- **TypeScript Support**: Fully typed for enhanced code quality and developer experience.
-- **Response Validation**: Validate responses using schemas for increased reliability and consistency.
-
-## 📥 Installation
-
-Install Klaim via npm:
-
-```sh
-// Using npm
-npm install klaim
-
-// Using bun
-bun add klaim
-
-// Using deno
-deno add @antharuu/klaim
-```
-
-## 🛠 Usage
-
-### Basic API Configuration
-
-First, set up the API configuration. Define the API and its base URL.
-
-```typescript
-import {Api, Route} from 'klaim';
-// For deno: import { Api, Route } from "@antharuu/klaim";
-
-// Your simple Todo type
-type Todo = {
-    userId: number;
-    id: number;
-    title: string;
-    completed: boolean;
-};
-
-// Create a new API with the name "hello" and the base URL "https://jsonplaceholder.typicode.com/"
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // Define routes for the API
-    Route.get<Todo[]>("listTodos", "todos");
-    Route.get<Todo>("getTodo", "todos/[id]");
-    Route.post<Todo>("addTodo", "todos");
-});
-```
-
-### Route Definition
-
-Define various routes within the API callback:
-
-```typescript
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // Get a list of todos
-    Route.get<Todo[]>("listTodos", "todos");
-
-    // Get a specific todo by id
-    Route.get<Todo>("getTodo", "todos/[id]");
-
-    // Add a new todo
-    Route.post<Todo>("addTodo", "todos");
-});
-```
-
-### Request Handling
-
-Handle requests using the defined routes:
-
-```typescript
-import {Klaim} from 'klaim';
-// For deno: import { Klaim } from "@antharuu/klaim";
-
-// Make a request to the "listTodos" route
-const listOfTodos = await Klaim.hello.listTodos<Todo[]>();
-
-// Make a request to the "getTodo" route with the parameter "id"
-const todo = await Klaim.hello.getTodo<Todo>({id: 1});
-
-// Make a request to the "addTodo" route
-const newTodo = await Klaim.hello.addTodo<Todo>({}, {title: "New Todo", completed: false, userId: 1});
-```
-
-### Middleware Usage
-
-Add middleware to modify requests and responses. Use `before` middleware to alter requests before they are sent
-and `after` middleware to process responses:
-
-```typescript
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // With before middleware
-    Route.get<Todo>("getRandomTodo", "todos")
-        .before(({url}) => {
-            const random = Math.floor(Math.random() * 10) + 1;
-            return {url: `${url}/${random}`};
-        });
-
-    // With after middleware
-    Route.get<Todo>("getFirstTodo", "todos")
-        .after(({data: [first]}) => ({data: first}));
-});
-```
-
-### Hook Subscription
-
-Subscribe to hooks to monitor specific events:
-
-```typescript
-import {Hook} from 'klaim';
-// For deno: import { Hook } from "@antharuu/klaim";
-
-// Subscribe to the "hello.getFirstTodo" hook
-Hook.subscribe("hello.getFirstTodo", ({url}) => {
-    console.log(`Requesting ${url}`);
-});
-```
-
-### Caching Requests
-
-Enable caching on requests to reduce network load and improve performance. By default, the cache duration is 20 seconds,
-but you can specify a custom duration in seconds.
-
-#### Caching Individual Routes
-
-You can enable caching on individual routes:
-
-```typescript
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // Get a list of todos with default cache duration (20 seconds)
-    Route.get<Todo[]>("listTodos", "todos").withCache();
-
-    // Get a specific todo by id with custom cache duration (300 seconds)
-    Route.get<Todo>("getTodo", "todos/[id]").withCache(300);
-
-    // Add a new todo (no cache)
-    Route.post<Todo>("addTodo", "todos");
-});
-```
-
-Now, when making requests, the caching feature will be applied.
-
-#### Caching the Entire API
-
-You can also enable caching for all routes defined within an API:
-
-```typescript
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // Define routes for the API
-    Route.get<Todo[]>("listTodos", "todos");
-    Route.get<Todo>("getTodo", "todos/[id]");
-    Route.post<Todo>("addTodo", "todos");
-}).withCache(); // Enable default cache duration (20 seconds) for all routes
-```
-
-### Retry Mechanism
-
-Automatically retry failed requests to enhance reliability. You can specify the number of retry attempts for individual
-routes or for the entire API.
-
-#### Retry on Individual Routes
-
-Enable retry on individual routes:
-
-```typescript
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // Get a list of todos with retry mechanism (default: 2)
-    Route.get<Todo[]>("listTodos", "todos").withRetry();
-
-    // Get a specific todo by id with retry mechanism (specified to 5)
-    Route.get<Todo>("getTodo", "todos/[id]").withRetry(5);
-
-    // Add a new todo (no retry)
-    Route.post<Todo>("addTodo", "todos");
-});
-```
-
-#### Retry the Entire API
-
-Enable retry for all routes defined within an API:
-
-```typescript
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // Define routes for the API
-    Route.get<Todo[]>("listTodos", "todos");
-    Route.get<Todo>("getTodo", "todos/[id]");
-    Route.post<Todo>("addTodo", "todos");
-}).withRetry();
-```
-
-Now, when a request fails, it will be retried the specified number of times before ultimately failing.
-
-### Response Validation
-
-You can use [Yup](https://www.npmjs.com/package/yup) to validate the response schema for increased reliability and consistency. You can specify a schema for
-individual routes to ensure the response data conforms to the expected structure.
-
-⚠️ **Note**: This feature requires the `yup` package to be installed.
-
-#### Adding Validation to Individual Routes
-
-Enable validation on individual routes:
-
-```typescript
-import * as yup from 'yup';
-
-// Define the schema using Yup
-const todoSchema = yup.object().shape({
-    userId: yup.number().required(),
-    id: yup.number().min(1).max(10).required(),
-    title: yup.string().required(),
-    completed: yup.boolean().required()
-});
-
-Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
-    // Get a specific todo by id with validation
-    Route.get<Todo>("getTodo", "todos/[id]").validate(todoSchema);
-});
-
-// This request will fail because the id is out of range
-const todoFail = await Klaim.hello.getTodo<Todo>({id: 15});
-
-// This request will succeed
-const todo = await Klaim.hello.getTodo<Todo>({id: 1});
-```
-
-## 🔗 Links
-
-- [NPM](https://www.npmjs.com/package/klaim)
-- [JSR](https://jsr.io/@antharuu/klaim)
-- [GitHub](https://github.com/antharuu/klaim)
-
-## 🤝 Contributing
-
-Contributions are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for more details.
-
-## 📜 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+## 📚 Table of Contents
+
+- [Features](#-features)
+- [Installation](#-installation)
+- [Usage](#-usage)
+    - [Basic API Configuration](#basic-api-configuration)
+    - [Route Definition](#route-definition)
+    - [Request Handling](#request-handling)
+    - [Middleware Usage](#middleware-usage)
+    - [Hook Subscription](#hook-subscription)
+    - [Caching Requests](#caching-requests)
+    - [Retry Mechanism](#retry-mechanism)
+    - [Response Validation](#response-validation)
+- [Links](#-links)
+- [Contributing](#-contributing)
+- [License](#-license)
+
+## 🚀 Features
+
+- **Efficient API Management**: Easily manage multiple APIs with streamlined integration and interaction capabilities.
+- **Request Recording**: Seamlessly track requests for debugging and monitoring.
+- **User Experience Optimization**: Focused on performance and usability for a smooth user experience.
+- **Lightweight**: Minimal footprint for fast load times and minimal performance impact.
+- **Middleware Support**: Easily add middleware to modify requests and responses (`before` and `after`).
+- **Hook System**: Subscribe to hooks to monitor and react to specific events.
+- **Caching**: Enable caching on requests to reduce network load and improve performance.
+- **Retry Mechanism**: Automatically retry failed requests to enhance reliability.
+- **TypeScript Support**: Fully typed for enhanced code quality and developer experience.
+- **Response Validation**: Validate responses using schemas for increased reliability and consistency.
+
+## 📥 Installation
+
+Install Klaim via npm:
+
+```sh
+// Using npm
+npm install klaim
+
+// Using bun
+bun add klaim
+
+// Using deno
+deno add @antharuu/klaim
+```
+
+## 🛠 Usage
+
+### Basic API Configuration
+
+First, set up the API configuration. Define the API and its base URL.
+
+```typescript
+import {Api, Route} from 'klaim';
+// For deno: import { Api, Route } from "@antharuu/klaim";
+
+// Your simple Todo type
+type Todo = {
+    userId: number;
+    id: number;
+    title: string;
+    completed: boolean;
+};
+
+// Create a new API with the name "hello" and the base URL "https://jsonplaceholder.typicode.com/"
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Define routes for the API
+    Route.get<Todo[]>("listTodos", "todos");
+    Route.get<Todo>("getTodo", "todos/[id]");
+    Route.post<Todo>("addTodo", "todos");
+});
+```
+
+### Route Definition
+
+Define various routes within the API callback:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Get a list of todos
+    Route.get<Todo[]>("listTodos", "todos");
+
+    // Get a specific todo by id
+    Route.get<Todo>("getTodo", "todos/[id]");
+
+    // Add a new todo
+    Route.post<Todo>("addTodo", "todos");
+});
+```
+
+### Request Handling
+
+Handle requests using the defined routes:
+
+```typescript
+import {Klaim} from 'klaim';
+// For deno: import { Klaim } from "@antharuu/klaim";
+
+// Make a request to the "listTodos" route
+const listOfTodos = await Klaim.hello.listTodos<Todo[]>();
+
+// Make a request to the "getTodo" route with the parameter "id"
+const todo = await Klaim.hello.getTodo<Todo>({id: 1});
+
+// Make a request to the "addTodo" route
+const newTodo = await Klaim.hello.addTodo<Todo>({}, {title: "New Todo", completed: false, userId: 1});
+```
+
+### Middleware Usage
+
+Add middleware to modify requests and responses. Use `before` middleware to alter requests before they are sent
+and `after` middleware to process responses:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // With before middleware
+    Route.get<Todo>("getRandomTodo", "todos")
+        .before(({url}) => {
+            const random = Math.floor(Math.random() * 10) + 1;
+            return {url: `${url}/${random}`};
+        });
+
+    // With after middleware
+    Route.get<Todo>("getFirstTodo", "todos")
+        .after(({data: [first]}) => ({data: first}));
+});
+```
+
+### Hook Subscription
+
+Subscribe to hooks to monitor specific events:
+
+```typescript
+import {Hook} from 'klaim';
+// For deno: import { Hook } from "@antharuu/klaim";
+
+// Subscribe to the "hello.getFirstTodo" hook
+Hook.subscribe("hello.getFirstTodo", ({url}) => {
+    console.log(`Requesting ${url}`);
+});
+```
+
+### Caching Requests
+
+Enable caching on requests to reduce network load and improve performance. By default, the cache duration is 20 seconds,
+but you can specify a custom duration in seconds.
+
+#### Caching Individual Routes
+
+You can enable caching on individual routes:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Get a list of todos with default cache duration (20 seconds)
+    Route.get<Todo[]>("listTodos", "todos").withCache();
+
+    // Get a specific todo by id with custom cache duration (300 seconds)
+    Route.get<Todo>("getTodo", "todos/[id]").withCache(300);
+
+    // Add a new todo (no cache)
+    Route.post<Todo>("addTodo", "todos");
+});
+```
+
+Now, when making requests, the caching feature will be applied.
+
+#### Caching the Entire API
+
+You can also enable caching for all routes defined within an API:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Define routes for the API
+    Route.get<Todo[]>("listTodos", "todos");
+    Route.get<Todo>("getTodo", "todos/[id]");
+    Route.post<Todo>("addTodo", "todos");
+}).withCache(); // Enable default cache duration (20 seconds) for all routes
+```
+
+### Retry Mechanism
+
+Automatically retry failed requests to enhance reliability. You can specify the number of retry attempts for individual
+routes or for the entire API.
+
+#### Retry on Individual Routes
+
+Enable retry on individual routes:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Get a list of todos with retry mechanism (default: 2)
+    Route.get<Todo[]>("listTodos", "todos").withRetry();
+
+    // Get a specific todo by id with retry mechanism (specified to 5)
+    Route.get<Todo>("getTodo", "todos/[id]").withRetry(5);
+
+    // Add a new todo (no retry)
+    Route.post<Todo>("addTodo", "todos");
+});
+```
+
+#### Retry the Entire API
+
+Enable retry for all routes defined within an API:
+
+```typescript
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Define routes for the API
+    Route.get<Todo[]>("listTodos", "todos");
+    Route.get<Todo>("getTodo", "todos/[id]");
+    Route.post<Todo>("addTodo", "todos");
+}).withRetry();
+```
+
+Now, when a request fails, it will be retried the specified number of times before ultimately failing.
+
+### Response Validation
+
+You can use [Yup](https://www.npmjs.com/package/yup) to validate the response schema for increased reliability and consistency. You can specify a schema for
+individual routes to ensure the response data conforms to the expected structure.
+
+⚠️ **Note**: This feature requires the `yup` package to be installed.
+
+#### Adding Validation to Individual Routes
+
+Enable validation on individual routes:
+
+```typescript
+import * as yup from 'yup';
+
+// Define the schema using Yup
+const todoSchema = yup.object().shape({
+    userId: yup.number().required(),
+    id: yup.number().min(1).max(10).required(),
+    title: yup.string().required(),
+    completed: yup.boolean().required()
+});
+
+Api.create("hello", "https://jsonplaceholder.typicode.com/", () => {
+    // Get a specific todo by id with validation
+    Route.get<Todo>("getTodo", "todos/[id]").validate(todoSchema);
+});
+
+// This request will fail because the id is out of range
+const todoFail = await Klaim.hello.getTodo<Todo>({id: 15});
+
+// This request will succeed
+const todo = await Klaim.hello.getTodo<Todo>({id: 1});
+```
+
+## 🔗 Links
+
+- [NPM](https://www.npmjs.com/package/klaim)
+- [JSR](https://jsr.io/@antharuu/klaim)
+- [GitHub](https://github.com/antharuu/klaim)
+
+## 🤝 Contributing
+
+Contributions are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for more details.
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/deno.json

@@ -1,38 +1,38 @@
-{
-    "name": "@antharuu/klaim",
-    "version": "1.6.0",
-    "description": "Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user experience.",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/antharuu/klaim.git"
-    },
-    "keywords": [
-        "typescript",
-        "api",
-        "request",
-        "user experience",
-        "optimization",
-        "lightweight"
-    ],
-    "author": "antharuu",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/antharuu/klaim/issues"
-    },
-    "homepage": "https://github.com/antharuu/klaim#readme",
-    "main": "dist/klaim.cjs.js",
-    "module": "dist/klaim.es.js",
-    "types": "dist/index.d.ts",
-    "exports": "./mod.ts",
-    "scripts": {
-        "build": "vite build",
-        "dev": "vite build --watch",
-        "test": "vitest",
-        "lint": "eslint src",
-        "lint:fix": "eslint src **/*.ts --fix",
-        "release": "dotenv release-it --"
-    },
-    "peerDependencies": {
-        "typescript": "^5.5.3"
-    }
-}
+{
+    "name": "@antharuu/klaim",
+    "version": "1.6.2",
+    "description": "Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user experience.",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/antharuu/klaim.git"
+    },
+    "keywords": [
+        "typescript",
+        "api",
+        "request",
+        "user experience",
+        "optimization",
+        "lightweight"
+    ],
+    "author": "antharuu",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/antharuu/klaim/issues"
+    },
+    "homepage": "https://github.com/antharuu/klaim#readme",
+    "main": "dist/klaim.cjs.js",
+    "module": "dist/klaim.es.js",
+    "types": "dist/index.d.ts",
+    "exports": "./mod.ts",
+    "scripts": {
+        "build": "vite build",
+        "dev": "vite build --watch",
+        "test": "vitest",
+        "lint": "eslint src",
+        "lint:fix": "eslint src **/*.ts --fix",
+        "release": "dotenv release-it --"
+    },
+    "peerDependencies": {
+        "typescript": "^5.5.3"
+    }
+}