@gzl10/nexus-sdk 0.4.0 → 0.5.0

package/README.md

@@ -21,7 +21,6 @@ import type { ModuleManifest, PluginAuthRequest } from '@gzl10/nexus-sdk'
 
 export const tasksModule: ModuleManifest = {
   name: 'tasks',
-  code: 'TSK',
   label: 'Tasks',
   icon: 'mdi:checkbox-marked-outline',
   description: 'Task management',
@@ -88,7 +87,6 @@ import { projectsModule } from './modules/projects'
 
 export const projectPlugin: PluginManifest = {
   name: '@myorg/nexus-projects',
-  code: 'PRJ',
   label: 'Projects',
   icon: 'mdi:folder-outline',
   category: 'content',
@@ -188,6 +186,77 @@ const permissions = generateCaslPermissions(postEntity)
 // Returns: Array<{ role, action, subject, conditions, fields, inverted }>
 ```
 
+## CLI (v0.5.0+)
+
+Auto-generate code from EntityDefinitions in your modules:
+
+```bash
+# Install globally or use npx
+npx @gzl10/nexus-sdk generate
+
+# Generate for all modules in src/modules
+nexus-sdk generate --path src/modules
+
+# Generate for specific module
+nexus-sdk generate --module users
+
+# Watch mode for development
+nexus-sdk generate --watch
+
+# Dry run (preview without writing)
+nexus-sdk generate --dry-run --verbose
+```
+
+### CLI Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `-p, --path <dir>` | `src/modules` | Base modules directory |
+| `-m, --module <name>` | - | Generate only specific module |
+| `-o, --output <dir>` | `__generated__` | Output directory name |
+| `-w, --watch` | - | Watch for changes and regenerate |
+| `--dry-run` | - | Show what would be generated |
+| `--skip-schemas` | - | Skip `.schemas.ts` generation |
+| `--skip-models` | - | Skip `.models.ts` generation |
+| `--skip-migrations` | - | Skip `.migrate.ts` generation |
+| `--skip-casl` | - | Skip `.casl.ts` generation |
+| `--verbose` | - | Show detailed logs |
+
+### Generated Files
+
+For each module with `definitions`, the CLI generates:
+
+```text
+src/modules/posts/
+├── index.ts              # Module manifest with definitions
+└── __generated__/
+    ├── posts.schemas.ts  # Zod validation schemas
+    ├── posts.models.ts   # TypeScript interfaces
+    ├── posts.migrate.ts  # Knex migration function
+    └── posts.casl.ts     # CASL permission seeds
+```
+
+### Module Structure
+
+The CLI discovers modules by looking for `index.ts` files that export a `ModuleManifest` with `definitions`:
+
+```typescript
+// src/modules/posts/index.ts
+import type { ModuleManifest, EntityDefinition } from '@gzl10/nexus-sdk'
+
+const postEntity: EntityDefinition = {
+  type: 'collection',
+  table: 'posts',
+  // ...
+}
+
+export const postsModule: ModuleManifest = {
+  name: 'posts',
+  label: 'Posts',
+  definitions: [postEntity]
+}
+```
+
 ## Main Types
 
 ### Manifests & Context
@@ -237,8 +306,7 @@ const permissions = generateCaslPermissions(postEntity)
 
 | Type | Description |
 |------|-------------|
-| `CoreServices` | Core services container (`users`, etc.) |
-| `UsersResolver` | User lookup service (`findById`, `findByIds`) |
+| `EntityType` | Union of all entity type strings |
 | `PaginationParams` | Pagination input (`page`, `limit`) |
 | `PaginatedResult<T>` | Paginated response with metadata |
 | `ValidationSchema` | Generic Zod-compatible schema interface |
@@ -254,7 +322,7 @@ The context provides access to:
 - `middleware.validate()` - Request validation with Zod schemas
 - `errors` - Error classes (`AppError`, `NotFoundError`, `UnauthorizedError`, etc.)
 - `abilities` - CASL helpers (`subject`, `ForbiddenError`)
-- `services` - Core services (`users.findById`, `users.findByIds`)
+- `services` - Registered services (extensible)
 - `events` - EventEmitter for inter-module communication
 - `mail` - Email sending service