@trapi/metadata 0.1.8 → 0.2.0
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 +5 -11
- package/package.json +15 -7
package/README.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# @trapi/metadata 📚
|
|
2
2
|
|
|
3
|
-
[](https://github.com/Tada5hi/trapi/actions/workflows/main.yml)
|
|
4
|
+
[](https://codecov.io/gh/Tada5hi/trapi)
|
|
5
|
+
[](https://snyk.io/test/github/Tada5hi/trapi)
|
|
6
6
|
[](https://badge.fury.io/js/@trapi%2Fmetadata)
|
|
7
7
|
|
|
8
8
|
This package is responsible for generating metadata information by analyzing TypeScript REST decorators (self defined or third-party libraries).
|
|
9
9
|
The metadata can than be used for generating a documentation according to the OpenAPI Specification or to create route schema/handling for libraries like: express, koa, etc.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Inspect the `CHANGELOG.md` in the repository for breaking changes.
|
|
12
12
|
|
|
13
13
|
**Table of Contents**
|
|
14
14
|
|
|
@@ -16,9 +16,8 @@ Please read the `CHANGELOG.md` in the repository for breaking changes.
|
|
|
16
16
|
- [Configuration](#configuration)
|
|
17
17
|
- [Limitations](#limitations)
|
|
18
18
|
- [Usage](#usage)
|
|
19
|
-
- [Decorator(s)](#decorator)
|
|
20
|
-
- [Generator](#generator)
|
|
21
19
|
- [Structure](#structure)
|
|
20
|
+
|
|
22
21
|
## Installation
|
|
23
22
|
|
|
24
23
|
```bash
|
|
@@ -172,8 +171,3 @@ console.log(metadata);
|
|
|
172
171
|
## Structure
|
|
173
172
|
|
|
174
173
|
**coming soon**
|
|
175
|
-
|
|
176
|
-
## Credits
|
|
177
|
-
Parts of this package **@trapi/metadata** code rest on a continued fork repository ([typescript-swagger](https://github.com/Tada5hi/typescript-swagger)) of the
|
|
178
|
-
[typescript-rest-swagger](https://github.com/thiagobustamante/typescript-rest-swagger) library of [thiagobustamante](https://github.com/thiagobustamante)
|
|
179
|
-
and was also inspired by the [tsoa](https://github.com/lukeautry/tsoa) library of [lukeatury](https://github.com/lukeautry).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trapi/metadata",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Generate REST-API metadata scheme from TypeScript Decorators.",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"typings": "./dist/index.d.ts",
|
|
@@ -29,21 +29,29 @@
|
|
|
29
29
|
"url": "https://github.com/tada5hi"
|
|
30
30
|
},
|
|
31
31
|
"license": "MIT",
|
|
32
|
+
"repository": {
|
|
33
|
+
"type": "git",
|
|
34
|
+
"url": "git+https://github.com/Tada5hi/trapi.git"
|
|
35
|
+
},
|
|
36
|
+
"bugs": {
|
|
37
|
+
"url": "https://github.com/Tada5hi/trapi/issues"
|
|
38
|
+
},
|
|
39
|
+
"homepage": "https://github.com/Tada5hi/trapi#readme",
|
|
32
40
|
"devDependencies": {
|
|
33
41
|
"@types/glob": "^7.2.0",
|
|
34
42
|
"@types/minimatch": "^3.0.5",
|
|
35
|
-
"@types/yup": "^0.29.
|
|
43
|
+
"@types/yup": "^0.29.14",
|
|
36
44
|
"jsonata": "^1.8.6"
|
|
37
45
|
},
|
|
38
46
|
"dependencies": {
|
|
39
|
-
"@trapi/metadata-utils": "^0.0
|
|
40
|
-
"glob": "^
|
|
41
|
-
"minimatch": "^5.0
|
|
42
|
-
"typescript": "^4.
|
|
47
|
+
"@trapi/metadata-utils": "^0.1.0",
|
|
48
|
+
"glob": "^8.0.3",
|
|
49
|
+
"minimatch": "^5.1.0",
|
|
50
|
+
"typescript": "^4.7.4",
|
|
43
51
|
"yup": "^0.32.11"
|
|
44
52
|
},
|
|
45
53
|
"publishConfig": {
|
|
46
54
|
"access": "public"
|
|
47
55
|
},
|
|
48
|
-
"gitHead": "
|
|
56
|
+
"gitHead": "d59081f635380a76aabe902ddb5a6f8ac102eb26"
|
|
49
57
|
}
|