@rxap/plugin-nestjs 20.2.0-dev.0 → 20.2.0-dev.11

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.
Files changed (21) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/README.md +105 -105
  3. package/generators.json +5 -0
  4. package/package.json +11 -11
  5. package/src/generators/dynamic-configuration-module/index.d.ts +2 -0
  6. package/src/generators/dynamic-configuration-module/index.js +7 -0
  7. package/src/generators/dynamic-configuration-module/index.js.map +1 -0
  8. package/src/generators/dynamic-configuration-module/schema.json +9 -4
  9. package/src/generators/feature-microservice/schema.json +25 -18
  10. package/src/generators/frontend-microservice/schema.json +28 -20
  11. package/src/generators/health-indicator/schema.json +8 -4
  12. package/src/generators/health-indicator-init/schema.json +5 -2
  13. package/src/generators/init/schema.json +10 -5
  14. package/src/generators/init-application/schema.json +41 -26
  15. package/src/generators/init-library/schema.json +13 -7
  16. package/src/generators/jwt/schema.json +12 -2
  17. package/src/generators/microservice/schema.json +102 -28
  18. package/src/generators/open-api/schema.json +12 -2
  19. package/src/generators/sentry/schema.json +19 -4
  20. package/src/generators/swagger/schema.json +16 -3
  21. package/src/generators/validator/schema.json +11 -2
package/src/generators/microservice/schema.json CHANGED
@@ -6,29 +6,48 @@
6
6
  "properties": {
7
7
  "name": {
8
8
  "type": "string",
9
- "description": "The name of microservice",
10
- "x-prompt": "Enter the name of the microservice?"
9
+ "description": "The name of the microservice.",
10
+ "x-prompt": "What is the name of the microservice?",
11
+ "examples": [
12
+ "order-service"
13
+ ]
11
14
  },
12
15
  "directory": {
13
16
  "type": "string",
14
- "description": "The directory to create the microservice in"
17
+ "description": "The directory where the microservice will be created.",
18
+ "examples": [
19
+ "services"
20
+ ]
15
21
  },
16
22
 
17
23
  "sentry": {
18
24
  "type": "boolean",
19
25
  "default": true,
20
- "description": "Whether this service should use sentry",
21
- "x-prompt": "Should this service use sentry?"
26
+ "description": "Whether this microservice should use Sentry for error tracking.",
27
+ "x-prompt": "Should this microservice use Sentry?",
28
+ "examples": [
29
+ true,
30
+ false
31
+ ]
22
32
  },
23
33
  "skipFormat": {
24
34
  "type": "boolean",
25
- "default": false
35
+ "default": false,
36
+ "description": "Whether to skip formatting the generated files.",
37
+ "examples": [
38
+ true,
39
+ false
40
+ ]
26
41
  },
27
42
  "swagger": {
28
43
  "type": "boolean",
29
44
  "default": true,
30
- "description": "Whether this service should use swagger",
31
- "x-prompt": "Should this service support open-api config generation?"
45
+ "description": "Whether this microservice should use Swagger/OpenAPI for documentation.",
46
+ "x-prompt": "Should this microservice support OpenAPI configuration generation?",
47
+ "examples": [
48
+ true,
49
+ false
50
+ ]
32
51
  },
33
52
  "swaggerLive": {
34
53
  "type": "boolean",
@@ -37,26 +56,45 @@
37
56
  },
38
57
  "generateMain": {
39
58
  "type": "boolean",
40
- "description": "Whether the main file should be generated"
59
+ "description": "Whether the main entry point file (`main.ts`) should be generated.",
60
+ "default": true,
61
+ "examples": [
62
+ true,
63
+ false
64
+ ]
41
65
  },
42
66
  "healthIndicator": {
43
67
  "type": "boolean",
44
68
  "default": true,
45
- "description": "Whether this service should use a health indicator",
46
- "x-prompt": "Should this service have a health indicator endpoint?"
69
+ "description": "Whether this microservice should include a health indicator endpoint.",
70
+ "x-prompt": "Should this microservice have a health indicator endpoint?",
71
+ "examples": [
72
+ true,
73
+ false
74
+ ]
47
75
  },
48
76
  "healthIndicatorList": {
49
77
  "type": "array",
50
78
  "items": {
51
79
  "type": "string"
52
80
  },
53
- "description": "A list of health indicators"
81
+ "description": "A list of additional health indicators to include.",
82
+ "examples": [
83
+ [
84
+ "database",
85
+ "redis"
86
+ ]
87
+ ]
54
88
  },
55
89
  "validator": {
56
90
  "type": "boolean",
57
91
  "default": true,
58
- "description": "Whether this service use the ValidationPipe",
59
- "x-prompt": "Should this service use the ValidationPipe?"
92
+ "description": "Whether this microservice should use the NestJS `ValidationPipe`.",
93
+ "x-prompt": "Should this microservice use the `ValidationPipe`?",
94
+ "examples": [
95
+ true,
96
+ false
97
+ ]
60
98
  },
61
99
  "platform": {
62
100
  "type": "string",
@@ -65,55 +103,91 @@
65
103
  "fastify"
66
104
  ],
67
105
  "default": "express",
68
- "x-prompt": "Whichever platform should be used?"
106
+ "x-prompt": "Which platform should be used (Express or Fastify)?",
107
+ "examples": [
108
+ "express",
109
+ "fastify"
110
+ ]
69
111
  },
70
112
  "port": {
71
113
  "type": "number",
72
- "description": "The default port where the server is listens"
114
+ "description": "The default port number where the server will listen.",
115
+ "examples": [
116
+ 3000,
117
+ 8080
118
+ ]
73
119
  },
74
120
  "apiPrefix": {
75
121
  "oneOf": [
76
122
  {
77
123
  "type": "string",
78
- "description": "The default global api prefix"
124
+ "description": "The default global API prefix.",
125
+ "examples": [
126
+ "api"
127
+ ]
79
128
  },
80
129
  {
81
- "description": "Disable the global api prefix",
130
+ "description": "Disable the global API prefix.",
82
131
  "type": "boolean",
83
- "const": false
132
+ "const": false,
133
+ "examples": [
134
+ false
135
+ ]
84
136
  }
85
137
  ]
86
138
  },
87
139
  "sentryDsn": {
88
140
  "type": "string",
89
- "description": "Default sentry dsn"
141
+ "description": "The default Sentry DSN for error tracking.",
142
+ "examples": [
143
+ "https://examplePublicKey@o0.ingest.sentry.io/0"
144
+ ]
90
145
  },
91
146
  "overwrite": {
92
147
  "type": "boolean",
93
148
  "default": false,
94
- "description": "Whether to overwrite existing files"
149
+ "description": "Whether to overwrite existing files, if any.",
150
+ "examples": [
151
+ true,
152
+ false
153
+ ]
95
154
  },
96
155
  "jwt": {
97
156
  "type": "boolean",
98
157
  "default": false,
99
- "description": "Whether the application should use jwt",
100
- "x-prompt": "Should this service use jwt?"
158
+ "description": "Whether the microservice should use JWT for authentication.",
159
+ "x-prompt": "Should this microservice use JWT?",
160
+ "examples": [
161
+ true,
162
+ false
163
+ ]
101
164
  },
102
165
  "openApi": {
103
166
  "type": "boolean",
104
167
  "default": false,
105
- "description": "Whether the application should use openApi as client",
106
- "x-prompt": "Should this service use an open api client?"
168
+ "description": "Whether the microservice should use an OpenAPI client.",
169
+ "x-prompt": "Should this microservice use an OpenAPI client?",
170
+ "examples": [
171
+ true,
172
+ false
173
+ ]
107
174
  },
108
175
  "apiConfigurationFile": {
109
176
  "type": "string",
110
- "description": "The api configuration file to use"
177
+ "description": "The path to the API configuration file.",
178
+ "examples": [
179
+ "apps/my-api/src/assets/api-config.json"
180
+ ]
111
181
  },
112
182
  "standalone": {
113
183
  "type": "boolean",
114
184
  "default": false,
115
- "description": "Whether the nest service should be standalone",
116
- "x-prompt": "Should this service be standalone?"
185
+ "description": "Whether the NestJS service should be standalone (without a module).",
186
+ "x-prompt": "Should this microservice be standalone?",
187
+ "examples": [
188
+ true,
189
+ false
190
+ ]
117
191
  }
118
192
  },
119
193
  "required": [
package/src/generators/open-api/schema.json CHANGED
@@ -6,10 +6,20 @@
6
6
  "properties": {
7
7
  "project": {
8
8
  "type": "string",
9
- "description": ""
9
+ "description": "The name of the project to add OpenApi support to.",
10
+ "x-prompt": "Which project should be extended with OpenApi support?",
11
+ "examples": [
12
+ "my-api"
13
+ ]
10
14
  },
11
15
  "overwrite": {
12
- "type": "boolean"
16
+ "type": "boolean",
17
+ "description": "Whether to overwrite existing files.",
18
+ "default": false,
19
+ "examples": [
20
+ true,
21
+ false
22
+ ]
13
23
  }
14
24
  },
15
25
  "required": [
package/src/generators/sentry/schema.json CHANGED
@@ -10,20 +10,35 @@
10
10
  "$default": {
11
11
  "$source": "projectName"
12
12
  },
13
- "x-prompt": "Which project should be extend with sentry support?"
13
+ "x-prompt": "Which project should be extended with sentry support?",
14
+ "examples": [
15
+ "my-app"
16
+ ]
14
17
  },
15
18
  "dsn": {
16
19
  "type": "string",
17
- "description": "Default sentry dsn"
20
+ "description": "The default Sentry DSN.",
21
+ "examples": [
22
+ "https://examplePublicKey@o0.ingest.sentry.io/0"
23
+ ]
18
24
  },
19
25
  "required": {
20
26
  "type": "boolean",
21
- "description": "Whether or not the sentry dsn should be required to start the application"
27
+ "description": "Whether or not the Sentry DSN should be required to start the application.",
28
+ "default": false,
29
+ "examples": [
30
+ true,
31
+ false
32
+ ]
22
33
  },
23
34
  "overwrite": {
24
35
  "type": "boolean",
25
36
  "default": false,
26
- "description": "Whether to overwrite existing files"
37
+ "description": "Whether to overwrite existing files.",
38
+ "examples": [
39
+ true,
40
+ false
41
+ ]
27
42
  }
28
43
  },
29
44
  "required": [
package/src/generators/swagger/schema.json CHANGED
@@ -10,15 +10,28 @@
10
10
  "$default": {
11
11
  "$source": "projectName"
12
12
  },
13
- "x-prompt": "Which project should be initialized?"
13
+ "x-prompt": "Which project should be initialized with Swagger support?",
14
+ "examples": [
15
+ "my-api"
16
+ ]
14
17
  },
15
18
  "overwrite": {
16
- "type": "boolean"
19
+ "type": "boolean",
20
+ "description": "Whether to overwrite existing files.",
21
+ "default": false,
22
+ "examples": [
23
+ true,
24
+ false
25
+ ]
17
26
  },
18
27
  "standalone": {
19
28
  "type": "boolean",
20
29
  "default": false,
21
- "description": "Whether the nest service should be standalone"
30
+ "description": "Whether the NestJS service should be standalone.",
31
+ "examples": [
32
+ true,
33
+ false
34
+ ]
22
35
  }
23
36
  },
24
37
  "required": [
package/src/generators/validator/schema.json CHANGED
@@ -10,10 +10,19 @@
10
10
  "$default": {
11
11
  "$source": "projectName"
12
12
  },
13
- "x-prompt": "Which project should be extend with sentry support?"
13
+ "x-prompt": "Which project should be extended with validation support?",
14
+ "examples": [
15
+ "my-api"
16
+ ]
14
17
  },
15
18
  "overwrite": {
16
- "type": "boolean"
19
+ "type": "boolean",
20
+ "description": "Whether to overwrite existing files.",
21
+ "default": false,
22
+ "examples": [
23
+ true,
24
+ false
25
+ ]
17
26
  }
18
27
  },
19
28
  "required": [