klaim 1.2.28 → 1.2.30

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+antho.eclips@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to Klaim
+
+Thank you for your interest in contributing to Klaim! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug, please open an issue describing the problem, steps to reproduce it, and any relevant information such as your environment and version.
+
+### Suggesting Enhancements
+
+If you have an idea for a new feature or improvement, please open an issue to discuss it before submitting a pull request. This helps us coordinate efforts and ensure the feature aligns with the project's goals.
+
+### Pull Requests
+
+1. Fork the repository and create your branch from `main`.
+2. If you've added code, make sure it is covered by tests.
+3. Ensure the test suite passes.
+4. Submit your pull request, linking to the issue it addresses.
+
+## Code Style
+
+Please adhere to the coding standards used in the project. This includes following the existing style and using TypeScript for type definitions.
+
+## Commit Messages
+
+Write clear and concise commit messages. Follow the convention:

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Anthony Bellancourt
+
+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

@@ -3,11 +3,18 @@
 Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user
 experience.
 
-## Links
-
-- [NPM](https://www.npmjs.com/package/klaim)
-- [JSR](https://jsr.io/@antharuu/klaim)
-- [GitHub](https://github.com/antharuu/klaim)
+## 📚 Table of Contents
+
+- [Features](#-features)
+- [Installation](#-installation)
+- [Usage](#-usage)
+    - [Basic API Configuration](#basic-api-configuration)
+    - [Route Definition](#route-definition)
+    - [Request Handling](#request-handling)
+    - [Hook Subscription](#hook-subscription)
+- [Links](#-links)
+- [Contributing](#-contributing)
+- [License](#-license)
 
 ## 🚀 Features
 
@@ -36,11 +43,11 @@ deno add @antharuu/klaim
 
 ## 🛠 Usage
 
-Here’s a basic example to get you started:
+### Basic API Configuration
 
 ```typescript
 import {Api, Klaim, Route, Hook} from 'klaim';
-// For deno: import {Api, Klaim, Route, Hook} from "@antharuu/klaim";
+// For deno: import { Api, Klaim, Route, Hook } from "@antharuu/klaim";
 
 // Your simple Todo type
 type Todo = {
@@ -50,47 +57,72 @@ type Todo = {
     completed: boolean;
 }
 
-// --- Basic API configuration
 // 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");
-
-    // You can also define routes with parameters
-    Route.get<Todo>("getTodo", "todos/[id]");
-
-    // You can also define routes in post, (put, delete, etc)
-    Route.post<Todo>("addTodo", "todos");
-
-    // 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}));
-});
+Api.create("hello", "https://jsonplaceholder.typicode.com/");
+```
+
+### Route Definition
+
+Define routes for the API:
+
+```typescript
+// Define a route to get a list of todos
+Route.get<Todo[]>("listTodos", "todos");
+
+// Define a route to get a todo by id
+Route.get<Todo>("getTodo", "todos/[id]");
+
+// Define a route to add a new todo
+Route.post<Todo>("addTodo", "todos");
+
+// Define a route with before middleware
+Route.get<Todo>("getRandomTodo", "todos")
+    .before(({url}) => {
+        const random = Math.floor(Math.random() * 10) + 1;
+        return ({url: `${url}/${random}`});
+    });
+
+// Define a route with after middleware
+Route.get<Todo>("getFirstTodo", "todos")
+    .after(({data: [first]}) => ({data: first}));
+```
 
-// --- Usage
+### Request Handling
+
+Make requests using the defined routes:
+
+```typescript
 // Make a request to the "listTodos" route
-const listOfTodos = await Klaim.hello.todo<Todo>({id: 1})
+const listOfTodos = await Klaim.hello.todo<Todo>({id: 1});
 
 // Make a request to the "getTodo" route with the parameter "id"
-const todo = await Klaim.hello.getTodo<Todo>({id: 1})
+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})
+const newTodo = await Klaim.hello.addTodo<Todo>({}, {title: "New Todo", completed: false, userId: 1});
+```
 
-// You can subscribe to hooks from everywhere
-// Every time hello.getFirstTodo is called, the hook will be triggered
+### Hook Subscription
+
+Subscribe to hooks to monitor specific events:
+
+```typescript
+// Subscribe to the "hello.getFirstTodo" hook
 Hook.subscribe("hello.getFirstTodo", ({url}) => {
     console.log(`Requesting ${url}`);
 });
 ```
 
+## 🔗 Links
+
+- [NPM](https://www.npmjs.com/package/klaim)
+- [JSR](https://jsr.io/@antharuu/klaim)
+- [GitHub](https://github.com/antharuu/klaim)
+
 ## 🤝 Contributing
 
-Contributions are welcome!
+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/SECURITY.md

@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+We release updates and fixes regularly. We recommend using the latest version of Klaim to ensure you have the latest
+security patches.
+
+| Version | Supported          |
+|---------|--------------------|
+| 1.x     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you find a security vulnerability, please report it to us via email
+at [antho.eclips@gmail.com](mailto:antho.eclips@gmail.com). Do not open an issue on
+GitHub, as this might reveal the vulnerability publicly.
+
+Please include the following details in your report:
+
+- A description of the vulnerability
+- Steps to reproduce the vulnerability
+- Any relevant information such as your environment and version
+
+We will respond to your report as soon as possible and work with you to resolve the issue.

package/deno.json

@@ -1,6 +1,6 @@
 {
     "name": "@antharuu/klaim",
-    "version": "1.2.28",
+    "version": "1.2.30",
     "description": "Klaim is a lightweight TypeScript library designed to manage APIs and record requests, optimized for an optimal user experience.",
     "repository": {
         "type": "git",

package/package.json

@@ -20,7 +20,7 @@
     },
     "homepage": "https://github.com/antharuu/klaim#readme",
     "type": "module",
-    "version": "1.2.28",
+    "version": "1.2.30",
     "main": "dist/klaim.cjs.js",
     "module": "dist/klaim.es.js",
     "types": "dist/index.d.ts",

package/release-it.config.cjs

@@ -3,7 +3,7 @@ require('./load-env.cjs');
 
 module.exports = {
     github: {
-        release: false,
+        release: true,
     },
     npm: {
         publish: false,