@alevnyacow/nzmt 0.21.3 → 0.22.0

package/README.md

@@ -124,6 +124,27 @@ export default async function Page() {
 }
 ```
 
+# Scaffolder commands glossary
+
+## Complex scaffolding
+
+| Command | Description |
+|---------|-------------|
+| `npx nzmt crud-api <name>` | CRUD via Server Actions and React Query hooks. |
+| `npx nzmt crud-service <name>` | CRUD via Server Actions (no Controllers, API Routes and React Query hooks). |
+| `npx nzmt se <name>` | Generate **e**ntity + **s**tore (contracts linked). |
+| `npx nzmt rq` | Generate API **r**outes and React **q**eries for all of your controllers. This command will also remove endpoints which don't exist anymore with according React query hooks |
+
+## Single module scaffolding
+
+| Command | Description |Options|
+|---------|-------------|-------|
+| `npx nzmt e <name>`  | Generate **e**ntity. ||
+| `npx nzmt vo <name>` | Generate **v**alue **o**bject. ||
+| `npx nzmt cs <name>`  | Generate **c**ustom **s**tore (all schemas are `z.object({})`). ||
+| `npx nzmt s <name>`  | Generate **s**ervice. |`i:UserStore,Logger` will automatically inject `UserStore` and `Logger`. E.g. `npx nzmt s shop i:UserStore,ProductStore` will create `ShopService` with already injected `UserStore` and `ProductStore`|
+| `npx nzmt c <name>`  | Generate **c**ontroller. |`i:UserService` will automatically inject `UserService`. `Logger` and `Guared` are injected by default regardless of `i:` option|
+
 # FAQ
 
 ## What does DDD-inspired mean?

package/bin/cli.js

@@ -403,21 +403,21 @@ function initPrisma() {
     )
 }
 
-function initEndpointGuards() {
+function initGuards() {
     const config = loadConfig()
-    const endpointGuardsFolder = path.resolve(process.cwd(), `${config.coreFolder}${config?.paths?.infrastructure}`, 'endpoint-guards')
+    const endpointGuardsFolder = path.resolve(process.cwd(), `${config.coreFolder}${config?.paths?.infrastructure}`, 'guards')
     fs.mkdirSync(endpointGuardsFolder, { recursive: true })
 
-    fs.writeFileSync(path.resolve(endpointGuardsFolder, 'endpoint-guards.ts'), [
+    fs.writeFileSync(path.resolve(endpointGuardsFolder, 'guards.ts'), [
         `import type { Controller } from '@alevnyacow/nzmt'`,
         '',
-        `export class EndpointGuards {`,
+        `export class Guards {`,
         `\tdummyGuard: Controller.Guard = async () => { return undefined }`,
         `}`
     ].join('\n'))
 
     fs.writeFileSync(path.resolve(endpointGuardsFolder, 'index.ts'), [
-        `export * from './endpoint-guards'`
+        `export * from './guards'`
     ].join('\n'))
 
     // Update DI
@@ -427,13 +427,13 @@ function initEndpointGuards() {
     insertBeforeLineInFile(
         diEntriesPath,
         'type DIEntries =',
-        `import { EndpointGuards } from '@${config?.paths?.infrastructure}/endpoint-guards'`
+        `import { Guards } from '@${config?.paths?.infrastructure}/guards'`
     )
 
     insertAfterLineInFile(
         diEntriesPath,
         '// Infrastructure',
-        `\tEndpointGuards,`,
+        `\tGuards,`,
     )
 
 }
@@ -490,7 +490,7 @@ if (command.toLowerCase() === 'init' || command === 'i') {
     initSharedErrors()
     initPrisma()
     initLogger()
-    initEndpointGuards()
+    initGuards()
 
     process.exit(0)
 }
@@ -686,7 +686,7 @@ function generateStores(lowerCase, upperCase, withEntityPreset) {
 
 }
 
-if (command.toLowerCase() === 'store' || command === 's') {
+if (command.toLowerCase() === 'store' || command === 'cs') {
     var [lowerCase, upperCase] = camelizeVariants(entityName)
     generateStores(lowerCase, upperCase)
     process.exit(0);
@@ -954,7 +954,7 @@ function generateService(lowerCase, upperCase, store) {
     )
 }
 
-if (command.toLowerCase() === 'service' || command === 'S') {
+if (command.toLowerCase() === 'service' || command === 's') {
     var [lowerCase, upperCase] = camelizeVariants(entityName)
     generateService(lowerCase, upperCase, false)
     process.exit(0)
@@ -971,12 +971,8 @@ function generateController(upperCase, lowerCase, crudService) {
     if (crudService && !injections.includes(crudService)) {
         injections = injections.concat(crudService)
     }
-    if (!injections.includes('Logger')) {
-        injections = injections.concat('Logger')
-    }
-    if (!injections.includes('EndpointGuards')) {
-        injections = injections.concat('EndpointGuards')
-    }
+
+    injections = ['Logger', 'Guards', ...injections.filter(x => x !== 'Logger' && x !== 'Guards')]
 
     const crudServiceLowercase = crudService ? crudService.substring(0, 1).toLowerCase() + crudService.substring(1) : undefined
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alevnyacow/nzmt",
-  "version": "0.21.3",
+  "version": "0.22.0",
   "description": "Next Zod Modules Toolkit",
   "keywords": ["next", "full-stack", "server", "backend", "cli", "scaffolder", "zod", "rest", "contract programming", "react-query", "ddd", "domain-driven"],
   "repository": {