@antelopejs/interface-database-decorators 0.0.2 → 0.0.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 +8 -18
- package/dist/antelope.test.js +9 -9
- package/dist/antelope.test.js.map +1 -1
- package/package.json +11 -15
package/README.md
CHANGED
|
@@ -3,39 +3,29 @@
|
|
|
3
3
|
# Interface Database Decorators
|
|
4
4
|
|
|
5
5
|
<div align="center">
|
|
6
|
+
<a href="https://www.npmjs.com/package/@antelopejs/interface-database-decorators"><img src="https://img.shields.io/npm/v/@antelopejs/interface-database-decorators?style=for-the-badge&labelColor=000000&color=000000" alt="npm"></a>
|
|
6
7
|
<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge&labelColor=000000"></a>
|
|
7
8
|
<a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
|
|
8
9
|
<a href="./docs/1.introduction.md"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
|
|
9
10
|
</div>
|
|
10
11
|
|
|
11
|
-
A structured framework for implementing database operations using TypeScript decorators. Interface Database Decorators
|
|
12
|
+
A structured framework for implementing database operations using TypeScript decorators. Interface Database Decorators provides a flexible, object-oriented approach to defining database tables, models, and operations with full type safety, including built-in support for field-level encryption, hashing, and localization.
|
|
12
13
|
|
|
13
14
|
## Installation
|
|
14
15
|
|
|
15
16
|
```bash
|
|
16
|
-
|
|
17
|
+
npm install @antelopejs/interface-database-decorators
|
|
17
18
|
```
|
|
18
19
|
|
|
19
20
|
## Documentation
|
|
20
21
|
|
|
21
22
|
Detailed documentation is available in the `docs` directory:
|
|
22
23
|
|
|
23
|
-
- [Introduction](./docs/1.introduction.md) - Overview and
|
|
24
|
-
- [Table Definitions](./docs/2.table-definitions.md) -
|
|
25
|
-
- [Table Modifiers](./docs/3.table-modifiers.md) -
|
|
26
|
-
- [Data Models](./docs/4.data-models.md) -
|
|
27
|
-
- [Parameter Decoration](./docs/5.parameter-decoration.md) -
|
|
28
|
-
|
|
29
|
-
## Current Status
|
|
30
|
-
|
|
31
|
-
This is the development version (`beta`) of the Interface Database Decorators. It is currently in pre-release stage and may undergo changes before the final release. The interface is not considered stable for production use without understanding that breaking changes may occur.
|
|
32
|
-
|
|
33
|
-
## Versions
|
|
34
|
-
|
|
35
|
-
| Version | Link | Status |
|
|
36
|
-
| ------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
|
|
37
|
-
| beta | [database-decorators@beta](https://github.com/AntelopeJS/database-decorators/tree/main/output/database-decorators/beta) | Waiting validation from community to go in v1 |
|
|
38
|
-
| 1 | _Not yet released_ | Planned stable release |
|
|
24
|
+
- [Introduction](./docs/1.introduction.md) - Overview and dependencies
|
|
25
|
+
- [Table Definitions](./docs/2.table-definitions.md) - Define database tables with decorators, indexes, and fixtures
|
|
26
|
+
- [Table Modifiers](./docs/3.table-modifiers.md) - Encryption, hashing, localization, and custom modifier creation
|
|
27
|
+
- [Data Models](./docs/4.data-models.md) - Create and use data models with CRUD operations
|
|
28
|
+
- [Parameter Decoration](./docs/5.parameter-decoration.md) - Inject models into API controllers
|
|
39
29
|
|
|
40
30
|
## License
|
|
41
31
|
|
package/dist/antelope.test.js
CHANGED
|
@@ -9,23 +9,23 @@ exports.default = (0, config_1.defineConfig)({
|
|
|
9
9
|
modules: {
|
|
10
10
|
mongodb: {
|
|
11
11
|
source: {
|
|
12
|
-
type: "
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
type: "package",
|
|
13
|
+
package: "@antelopejs/mongodb",
|
|
14
|
+
version: "1.0.0",
|
|
15
15
|
},
|
|
16
16
|
},
|
|
17
17
|
database_decorators: {
|
|
18
18
|
source: {
|
|
19
|
-
type: "
|
|
20
|
-
|
|
21
|
-
|
|
19
|
+
type: "package",
|
|
20
|
+
package: "@antelopejs/database-decorators",
|
|
21
|
+
version: "1.0.0",
|
|
22
22
|
},
|
|
23
23
|
},
|
|
24
24
|
api: {
|
|
25
25
|
source: {
|
|
26
|
-
type: "
|
|
27
|
-
|
|
28
|
-
|
|
26
|
+
type: "package",
|
|
27
|
+
package: "@antelopejs/api",
|
|
28
|
+
version: "1.0.0",
|
|
29
29
|
},
|
|
30
30
|
config: {
|
|
31
31
|
servers: [{ protocol: "http", host: "127.0.0.1", port: 5010 }],
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"antelope.test.js","sourceRoot":"","sources":["../src/antelope.test.ts"],"names":[],"mappings":";;AAAA,8DAAiE;AACjE,2EAA+D;AAE/D,IAAI,MAAyB,CAAC;AAE9B,kBAAe,IAAA,qBAAY,EAAC;IAC1B,IAAI,EAAE,oCAAoC;IAC1C,WAAW,EAAE,iBAAiB;IAC9B,OAAO,EAAE;QACP,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,IAAI,EAAE,
|
|
1
|
+
{"version":3,"file":"antelope.test.js","sourceRoot":"","sources":["../src/antelope.test.ts"],"names":[],"mappings":";;AAAA,8DAAiE;AACjE,2EAA+D;AAE/D,IAAI,MAAyB,CAAC;AAE9B,kBAAe,IAAA,qBAAY,EAAC;IAC1B,IAAI,EAAE,oCAAoC;IAC1C,WAAW,EAAE,iBAAiB;IAC9B,OAAO,EAAE;QACP,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,qBAAqB;gBAC9B,OAAO,EAAE,OAAO;aACjB;SACF;QACD,mBAAmB,EAAE;YACnB,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,iCAAiC;gBAC1C,OAAO,EAAE,OAAO;aACjB;SACF;QACD,GAAG,EAAE;YACH,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,iBAAiB;gBAC1B,OAAO,EAAE,OAAO;aACjB;YACD,MAAM,EAAE;gBACN,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;aAC/D;SACF;KACF;IACD,IAAI,EAAE;QACJ,MAAM,EAAE,YAAY;QACpB,KAAK,CAAC,KAAK;YACT,MAAM,GAAG,MAAM,8CAAiB,CAAC,MAAM,EAAE,CAAC;YAC1C,OAAO;gBACL,OAAO,EAAE;oBACP,OAAO,EAAE;wBACP,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE;qBACjC;iBACF;aACF,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,OAAO;YACX,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;KACF;CACF,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@antelopejs/interface-database-decorators",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
4
|
"description": "AntelopeJS interface for database schema decorators and model definitions",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"antelopejs",
|
|
@@ -25,10 +25,6 @@
|
|
|
25
25
|
"types": "./dist/index.d.ts",
|
|
26
26
|
"default": "./dist/index.js"
|
|
27
27
|
},
|
|
28
|
-
"./*": {
|
|
29
|
-
"types": "./dist/*.d.ts",
|
|
30
|
-
"default": "./dist/*.js"
|
|
31
|
-
},
|
|
32
28
|
"./package.json": "./package.json"
|
|
33
29
|
},
|
|
34
30
|
"scripts": {
|
|
@@ -41,25 +37,25 @@
|
|
|
41
37
|
"test": "pnpm run build && ajs module test ."
|
|
42
38
|
},
|
|
43
39
|
"dependencies": {
|
|
44
|
-
"@antelopejs/interface-api": "^0.0.
|
|
45
|
-
"@antelopejs/interface-core": "^0.0.
|
|
46
|
-
"@antelopejs/interface-database": "^0.0.
|
|
40
|
+
"@antelopejs/interface-api": "^0.0.3",
|
|
41
|
+
"@antelopejs/interface-core": "^0.0.3",
|
|
42
|
+
"@antelopejs/interface-database": "^0.0.4",
|
|
47
43
|
"randomstring": "^1.3.1",
|
|
48
44
|
"reflect-metadata": "^0.2.2"
|
|
49
45
|
},
|
|
50
46
|
"devDependencies": {
|
|
47
|
+
"@biomejs/biome": "2.3.2",
|
|
51
48
|
"@types/chai": "^4.3.20",
|
|
52
49
|
"@types/mocha": "^10.0.10",
|
|
53
|
-
"@types/node": "^22.
|
|
50
|
+
"@types/node": "^22.19.15",
|
|
54
51
|
"@types/randomstring": "^1.3.0",
|
|
55
|
-
"@
|
|
52
|
+
"@types/semver": "^7.7.1",
|
|
56
53
|
"chai": "^4.5.0",
|
|
57
|
-
"
|
|
54
|
+
"mongodb-memory-server-core": "^10.4.3",
|
|
55
|
+
"release-it": "^19.2.4",
|
|
58
56
|
"release-it-changelogen": "^0.1.0",
|
|
59
|
-
"rimraf": "^6.
|
|
60
|
-
"typescript": "^5.
|
|
61
|
-
"mongodb-memory-server-core": "^10.1.4",
|
|
62
|
-
"@types/semver": "^7.7.0"
|
|
57
|
+
"rimraf": "^6.1.3",
|
|
58
|
+
"typescript": "^5.9.3"
|
|
63
59
|
},
|
|
64
60
|
"publishConfig": {
|
|
65
61
|
"access": "public"
|