@restura/core 0.1.0-alpha.3 → 0.1.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# @restura/core
|
|
2
|
+
|
|
3
|
+
Restura is a powerful utility library for building Node.js backend applications with ease. It provides the core functionality to define, validate, and manage your REST API by generating Express.js routes from a schema file. Additionally, it integrates with PostgreSQL databases to handle SQL queries and offers comprehensive authentication and authorization capabilities.
|
|
4
|
+
|
|
5
|
+
`@restura/core` is the core library that powers the Restura framework. It provides the essential functionality to define your REST API, validate input parameters, generate SQL queries, and handle user authentication and authorization. The library is designed to be extensible and customizable, allowing you to build complex backend applications with minimal effort.
|
|
6
|
+
|
|
7
|
+
## Key Features
|
|
8
|
+
|
|
9
|
+
- **Schema-Based REST API**: Define your entire REST API in a schema file, and automatically generate all the required Express.js routes.
|
|
10
|
+
- **Input Validation**: Automatically detects and validates query and body parameters for all routes.
|
|
11
|
+
- **Authentication & Authorization**: Built-in support for handling user authentication and role-based authorization.
|
|
12
|
+
- **Database Query Generation**: Automatically generate and run SQL queries against a PostgreSQL database, returning properly formatted data.
|
|
13
|
+
- **Post-Validation**: Ensures all data returned from the database is correctly formatted according to your schema.
|
|
14
|
+
|
|
15
|
+
## Installation and Simple Usage
|
|
16
|
+
|
|
17
|
+
Install the library using npm:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm add @restura/core
|
|
21
|
+
|
|
22
|
+
// Todo add more usage instructions
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Full Documentation
|
|
27
|
+
|
|
28
|
+
Documentation can be found in the [official Restura documentation](https://restura.io/docs).
|
|
29
|
+
|
|
30
|
+
## License
|
|
31
|
+
|
|
32
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@restura/core",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.4",
|
|
4
4
|
"description": "Restura core utilities for No Code APIs",
|
|
5
5
|
"types": "./dist/index.d.ts",
|
|
6
6
|
"repository": "https://github.com/redsky-engineering/restura",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"sql generator"
|
|
23
23
|
],
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@restura/internal": "0.1.0-alpha.
|
|
25
|
+
"@restura/internal": "0.1.0-alpha.4"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"tsup": "^8.3.0"
|