@venizia/ignis-helpers 0.0.1-1 → 0.0.1-3
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/LICENSE.md +102 -0
- package/README.md +43 -0
- package/package.json +22 -29
package/LICENSE.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Ignis Framework License
|
|
2
|
+
|
|
3
|
+
Ignis is a TypeScript Server Infrastructure framework built on [Hono](https://hono.dev/).
|
|
4
|
+
|
|
5
|
+
## MIT License
|
|
6
|
+
|
|
7
|
+
Copyright (c) 2025 VENIZIA Ltd. Co.
|
|
8
|
+
|
|
9
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
10
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
11
|
+
in the Software without restriction, including without limitation the rights
|
|
12
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
13
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
14
|
+
furnished to do so, subject to the following conditions:
|
|
15
|
+
|
|
16
|
+
The above copyright notice and this permission notice shall be included in all
|
|
17
|
+
copies or substantial portions of the Software.
|
|
18
|
+
|
|
19
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
20
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
21
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
22
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
23
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
24
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
25
|
+
SOFTWARE.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Packages
|
|
30
|
+
|
|
31
|
+
This monorepo contains the following packages, all licensed under MIT:
|
|
32
|
+
|
|
33
|
+
| Package | Description |
|
|
34
|
+
|---------|-------------|
|
|
35
|
+
| `@venizia/ignis` | Core framework - controllers, services, decorators |
|
|
36
|
+
| `@venizia/ignis-helpers` | Utility helpers - logging, cron, Redis, queues, storage |
|
|
37
|
+
| `@venizia/ignis-inversion` | Dependency Injection & IoC container |
|
|
38
|
+
| `@venizia/dev-configs` | Shared ESLint, Prettier, TypeScript configurations |
|
|
39
|
+
| `@venizia/ignis-docs` | Documentation and MCP Server |
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Third-Party Dependencies
|
|
44
|
+
|
|
45
|
+
Ignis uses the following open-source libraries. We are grateful to the authors and contributors of these projects.
|
|
46
|
+
|
|
47
|
+
### Core Dependencies
|
|
48
|
+
|
|
49
|
+
| Library | License | Description |
|
|
50
|
+
|---------|---------|-------------|
|
|
51
|
+
| [Hono](https://github.com/honojs/hono) | MIT | Ultrafast web framework |
|
|
52
|
+
| [Zod](https://github.com/colinhacks/zod) | MIT | TypeScript-first schema validation |
|
|
53
|
+
| [Drizzle ORM](https://github.com/drizzle-team/drizzle-orm) | Apache-2.0 | TypeScript ORM |
|
|
54
|
+
| [Jose](https://github.com/panva/jose) | MIT | JavaScript Object Signing and Encryption |
|
|
55
|
+
|
|
56
|
+
### Helpers Dependencies
|
|
57
|
+
|
|
58
|
+
| Library | License | Description |
|
|
59
|
+
|---------|---------|-------------|
|
|
60
|
+
| [Winston](https://github.com/winstonjs/winston) | MIT | Universal logging library |
|
|
61
|
+
| [BullMQ](https://github.com/taskforcesh/bullmq) | MIT | Message queue and job scheduling |
|
|
62
|
+
| [IORedis](https://github.com/redis/ioredis) | MIT | Redis client for Node.js |
|
|
63
|
+
| [MinIO](https://github.com/minio/minio-js) | Apache-2.0 | S3-compatible object storage client |
|
|
64
|
+
| [Axios](https://github.com/axios/axios) | MIT | HTTP client |
|
|
65
|
+
| [Day.js](https://github.com/iamkun/dayjs) | MIT | Date manipulation library |
|
|
66
|
+
| [Cron](https://github.com/kelektiv/node-cron) | MIT | Cron job scheduler |
|
|
67
|
+
| [Socket.IO](https://github.com/socketio/socket.io) | MIT | Real-time bidirectional communication |
|
|
68
|
+
| [MQTT.js](https://github.com/mqttjs/MQTT.js) | MIT | MQTT client |
|
|
69
|
+
|
|
70
|
+
### Utility Dependencies
|
|
71
|
+
|
|
72
|
+
| Library | License | Description |
|
|
73
|
+
|---------|---------|-------------|
|
|
74
|
+
| [Lodash](https://github.com/lodash/lodash) | MIT | Utility library |
|
|
75
|
+
| [reflect-metadata](https://github.com/rbuckton/reflect-metadata) | Apache-2.0 | Metadata reflection API |
|
|
76
|
+
|
|
77
|
+
### Documentation Dependencies
|
|
78
|
+
|
|
79
|
+
| Library | License | Description |
|
|
80
|
+
|---------|---------|-------------|
|
|
81
|
+
| [VitePress](https://github.com/vuejs/vitepress) | MIT | Static site generator |
|
|
82
|
+
| [Fuse.js](https://github.com/krisk/fuse) | Apache-2.0 | Fuzzy search library |
|
|
83
|
+
| [gray-matter](https://github.com/jonschlinkert/gray-matter) | MIT | Front-matter parser |
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Acknowledgments
|
|
88
|
+
|
|
89
|
+
Ignis Framework is inspired by and built upon the work of many open-source projects:
|
|
90
|
+
|
|
91
|
+
- **[Hono](https://hono.dev/)** by Yusuke Wada - The ultrafast web framework that powers Ignis
|
|
92
|
+
- **[LoopBack 4](https://loopback.io/)** by IBM/StrongLoop - Inspiration for the enterprise architecture patterns
|
|
93
|
+
- **[NestJS](https://nestjs.com/)** by Kamil Mysliwiec - Inspiration for decorator-based controllers
|
|
94
|
+
- **[InversifyJS](https://inversify.io/)** - Inspiration for the IoC container design
|
|
95
|
+
|
|
96
|
+
We thank all the maintainers and contributors of these projects for their excellent work.
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## Contributing
|
|
101
|
+
|
|
102
|
+
By contributing to Ignis, you agree that your contributions will be licensed under the MIT License.
|
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# @venizia/ignis-helpers
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@venizia/ignis-helpers)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
6
|
+
A collection of **helpers and utilities** for the **Ignis Framework** - includes logging, cron jobs, Redis, queues, storage, and more.
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
bun add @venizia/ignis-helpers
|
|
12
|
+
# or
|
|
13
|
+
npm install @venizia/ignis-helpers
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Available Helpers
|
|
17
|
+
|
|
18
|
+
| Helper | Description |
|
|
19
|
+
|--------|-------------|
|
|
20
|
+
| **Logger** | Winston-based logging with daily rotation |
|
|
21
|
+
| **Cron** | Scheduled job management |
|
|
22
|
+
| **Redis** | Redis client wrapper with IoRedis |
|
|
23
|
+
| **Queue** | BullMQ-based job queue |
|
|
24
|
+
| **Storage** | MinIO/S3-compatible object storage |
|
|
25
|
+
| **Crypto** | Encryption and hashing utilities |
|
|
26
|
+
| **Network** | HTTP client with Axios |
|
|
27
|
+
| **Socket.IO** | Real-time communication helpers |
|
|
28
|
+
| **Error** | Standardized error handling |
|
|
29
|
+
| **Env** | Environment variable management |
|
|
30
|
+
|
|
31
|
+
## About Ignis
|
|
32
|
+
|
|
33
|
+
Ignis brings together the structured, enterprise development experience of **LoopBack 4** with the blazing speed and simplicity of **Hono** - giving you the best of both worlds.
|
|
34
|
+
|
|
35
|
+
## Documentation
|
|
36
|
+
|
|
37
|
+
- [Ignis Repository](https://github.com/venizia-ai/ignis)
|
|
38
|
+
- [Getting Started](https://github.com/venizia-ai/ignis/blob/main/packages/docs/wiki/get-started/index.md)
|
|
39
|
+
- [Helpers Reference](https://github.com/venizia-ai/ignis/blob/main/packages/docs/wiki/references/helpers/index.md)
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,29 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@venizia/ignis-helpers",
|
|
3
|
-
"version": "0.0.1-
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.0.1-3",
|
|
4
|
+
"description": "Utility helpers for the Ignis Framework - logging, cron, Redis, queues, storage, and more",
|
|
5
5
|
"keywords": [
|
|
6
|
-
"
|
|
7
|
-
"
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
"
|
|
11
|
-
"
|
|
12
|
-
"
|
|
13
|
-
"
|
|
14
|
-
"
|
|
6
|
+
"helpers",
|
|
7
|
+
"utilities",
|
|
8
|
+
"logging",
|
|
9
|
+
"winston",
|
|
10
|
+
"cron",
|
|
11
|
+
"redis",
|
|
12
|
+
"ioredis",
|
|
13
|
+
"queue",
|
|
14
|
+
"bullmq",
|
|
15
|
+
"storage",
|
|
16
|
+
"minio",
|
|
17
|
+
"s3",
|
|
18
|
+
"mqtt",
|
|
19
|
+
"socket.io",
|
|
15
20
|
"venizia",
|
|
16
|
-
"
|
|
17
|
-
"infra",
|
|
21
|
+
"ignis",
|
|
18
22
|
"bun",
|
|
19
23
|
"nodejs",
|
|
20
|
-
"
|
|
21
|
-
"class-based",
|
|
22
|
-
"framework",
|
|
23
|
-
"dependency injection",
|
|
24
|
-
"backend framework",
|
|
25
|
-
"nodejs framework",
|
|
26
|
-
"web framework"
|
|
24
|
+
"typescript"
|
|
27
25
|
],
|
|
28
26
|
"exports": {
|
|
29
27
|
".": {
|
|
@@ -34,7 +32,7 @@
|
|
|
34
32
|
},
|
|
35
33
|
"files": [
|
|
36
34
|
"README.md",
|
|
37
|
-
"LICENSE",
|
|
35
|
+
"LICENSE.md",
|
|
38
36
|
"dist",
|
|
39
37
|
"!/**/tests",
|
|
40
38
|
"!/**/dist/tests",
|
|
@@ -55,17 +53,12 @@
|
|
|
55
53
|
"prettier:cli": "prettier \"**/*.{js,ts}\" -l",
|
|
56
54
|
"prettier:fix": "bun run prettier:cli --write",
|
|
57
55
|
"rebuild": "sh ./scripts/rebuild.sh no-version",
|
|
58
|
-
"
|
|
59
|
-
"rebuild:minor": "sh ./scripts/rebuild.sh minor",
|
|
60
|
-
"rebuild:patch": "sh ./scripts/rebuild.sh patch",
|
|
61
|
-
"rebuild:premajor": "sh ./scripts/rebuild.sh premajor",
|
|
62
|
-
"rebuild:preminor": "sh ./scripts/rebuild.sh preminor",
|
|
63
|
-
"rebuild:prepatch": "sh ./scripts/rebuild.sh prepatch",
|
|
64
|
-
"rebuild:prerelease": "sh ./scripts/rebuild.sh prerelease"
|
|
56
|
+
"prepublishOnly": "bun run rebuild"
|
|
65
57
|
},
|
|
66
58
|
"repository": {
|
|
67
59
|
"type": "git",
|
|
68
|
-
"url": "git+https://github.com/VENIZIA-AI/ignis.git"
|
|
60
|
+
"url": "git+https://github.com/VENIZIA-AI/ignis.git",
|
|
61
|
+
"directory": "packages/helpers"
|
|
69
62
|
},
|
|
70
63
|
"author": {
|
|
71
64
|
"name": "VENIZIA AI Developer",
|