generator-pninja 1.1.1 → 1.2.1

package/README.md

@@ -60,15 +60,73 @@ yo pninja
 
 ```
 my-app/
-├── client/ # React + Vite app
-├── docker/ # Docker compose
-├── server/ # Laravel project
-├── package.json # With commands
+├── client/         # React + Vite app
+├── docker/         # Docker compose
+├── server/         # Laravel project
+├── package.json    # With commands
 └── README.md
 ```
 
 Fully wired together: auth, routing, forms, CRUD, migrations.
 
+## Core Features
+
+### Authentication & Authorization
+
+- **Keycloak Integration** - Enterprise-grade authentication
+- **ACL System (Casbin)** - Fine-grained access control with policies and roles
+- **Role-based Permissions** - Manage user permissions across entities
+
+### Data Management
+
+- **Soft Delete Support** - Logical deletion with `deleted_at` timestamps (use `@softDelete` annotation in JDL)
+  ```jdl
+  @softDelete
+  entity MyEntity {
+    name String required
+    description String
+  }
+  ```
+- **CSV Database Seeding** - Populate your database from CSV files
+- **Audit Logging** - Complete change tracking for all entity modifications
+
+### Search & Indexing
+
+- **Multiple Search Engines** - Choose from Database, Algolia, Elasticsearch, Meilisearch, Typesense, or Solr
+- **Laravel Scout Integration** - Seamless search engine configuration
+
+### Accessibility & UX
+
+- **WCAG 2.1 Level AA Compliance** - Built-in accessibility standards
+- **React Aria Components** - Accessible form components out-of-the-box
+- **Keyboard Navigation** - Full keyboard support for all interactions
+- **Screen Reader Support** - Optimized for assistive technologies
+
+### Internationalization
+
+- **i18next Integration** - Multi-language support ready to use
+- **RTL Support** - Right-to-left language compatibility
+
+### Modern UI/UX
+
+- **Responsive Design** - Mobile-first approach
+- **Tailwind CSS** - Utility-first styling
+- **Material Symbols Icons** - Associate icons to entities using `@icon` annotation in JDL
+  ```jdl
+  @icon("star")
+  entity MyEntity {
+    name String required
+    description String
+  }
+  ```
+- **Component Library** - Pre-built accessible components
+
+### DevOps Ready
+
+- **Docker Compose** - Full containerization support
+- **Environment Configuration** - Easy setup for different environments
+- **Database Migrations** - Version-controlled schema changes
+
 ## Supported Technologies and Limitations
 
 ### Server Framework (PHP)
@@ -87,16 +145,53 @@ Fully wired together: auth, routing, forms, CRUD, migrations.
 
 - [Keycloak][keycloak-url]
 
+### Authorization
+
+- [Casbin][casbin-url] - Policy-based access control
+
 ### Search Engines
 
 - [Algolia][algolia-url], [Elasticsearch][elasticsearch-url], [Meilisearch][meilisearch-url], [Typesense][typesense-url], [Solr][solr-url], Database
 
-### Roadmap
+### Frontend Libraries
 
-- [Vue][vue-url] & [Angular][angular-url] support
-- [SQL Server][sqlserver-url] & [Oracle][oracle-url] support
-- Authentication improvements ([Laravel Sanctum][sanctum-url] / [OAuth2][oauth2-url])
-- GitHub CI
+- [Tailwind CSS][tailwind-url]
+- [React Aria][react-aria-url] - Accessible component primitives
+- [Material Symbols][material-symbols-url] - Icon library
+
+### Internationalization
+
+- [i18next][i18next-url]
+
+## Roadmap
+
+### Frontend Frameworks
+
+- [Vue][vue-url] support
+- [Angular][angular-url] support
+
+### Database Support
+
+- [SQL Server][sqlserver-url] support
+- [Oracle][oracle-url] support
+
+### Features
+
+- **Multi-tenancy Support** - Isolated data per tenant
+- **API Versioning** - Version management for APIs
+- **Real-time Features** - WebSockets/Pusher integration
+- **GraphQL Support** - Alternative API layer
+- **Advanced Caching** - Redis integration with cache strategies
+
+### DevOps
+
+- **GitHub Actions CI/CD** - Automated testing and deployment
+- **Kubernetes Support** - Container orchestration configs
+
+### Authentication Enhancements
+
+- [Laravel Sanctum][sanctum-url] - SPA authentication option
+- Social Login (Google, GitHub, Facebook)
 
 ## GitHub Repository
 
@@ -104,6 +199,14 @@ The source code for **generator-pninja** is hosted on GitHub. You can access the
 
 [Generator PNinja GitHub Repository](https://github.com/consiglionazionaledellericerche/generator-pninja)
 
+## Contributing
+
+Contributions are welcome! Feel free to open issues or pull requests on the [GitHub repository](https://github.com/consiglionazionaledellericerche/generator-pninja).
+
+## Support
+
+For issues, questions, or feature requests, please use the [GitHub Issues](https://github.com/consiglionazionaledellericerche/generator-pninja/issues) page.
+
 [laravel-url]: https://laravel.com/
 [sqlite-url]: https://www.sqlite.org/
 [mysql-url]: https://www.mysql.com/
@@ -114,6 +217,7 @@ The source code for **generator-pninja** is hosted on GitHub. You can access the
 [npm-url]: https://www.npmjs.com/
 [yarn-url]: https://yarnpkg.com/
 [keycloak-url]: https://www.keycloak.org/
+[casbin-url]: https://casbin.org/
 [session-auth-url]: https://laravel.com/docs/session
 [sanctum-url]: https://laravel.com/docs/sanctum
 [oauth2-url]: https://oauth.net/2/
@@ -129,6 +233,10 @@ The source code for **generator-pninja** is hosted on GitHub. You can access the
 [typesense-url]: https://typesense.org/
 [solr-url]: https://solr.apache.org/
 [docker-compose-url]: https://docs.docker.com/compose/
+[tailwind-url]: https://tailwindcss.com/
+[react-aria-url]: https://react-spectrum.adobe.com/react-aria/
+[material-symbols-url]: https://fonts.google.com/icons
+[i18next-url]: https://www.i18next.com/
 [license-badge]: https://img.shields.io/badge/License-Apache_2.0-blue.svg
 [license-url]: https://opensource.org/licenses/Apache-2.0
 [npm-version-badge]: https://badge.fury.io/js/generator-pninja.svg

package/generators/app/index.js

@@ -145,23 +145,6 @@ export default class extends Generator {
             disabled: "Not implemented yet"
           }
         ]
-      }, {
-        store: true,
-        type: "list",
-        name: "packageManager",
-        message: "Your package manager",
-        default: "npm",
-        choices: [
-          {
-            name: "Npm",
-            value: "npm"
-          },
-          {
-            name: "Yarn",
-            value: "yarn",
-            disabled: "Not implemented yet"
-          }
-        ]
       },
     ]);
   }
@@ -174,12 +157,11 @@ export default class extends Generator {
   }
 
   async writing() {
-    const { entities, relationships } = this.fs.readJSON(this.destinationPath(`.pninja/Entities.json`));
-    this.fs.copyTpl(this.templatePath(`README.md.ejs`), this.destinationPath(`README.md`), { appName: this.config.get('name'), entities, relationships, searchEngine: this.config.get('searchEngine') });
     await this.spawn('composer', ['create-project', '--prefer-dist', 'laravel/laravel=~11.6.1', 'server']);
     await this.spawn('composer', ['require', '--dev', 'beyondcode/laravel-dump-server'], { cwd: 'server' });
     await this.spawn('php', ['artisan', 'install:api', '--without-migration-prompt'], { cwd: 'server' });
     await this.spawn('composer', ['require', 'casbin/laravel-authz'], { cwd: 'server' });
+    await this.spawn('composer', ['require', 'owen-it/laravel-auditing'], { cwd: 'server' });
     let envFileContents = fs.readFileSync(`${this.destinationPath('server')}/.env`, { encoding: 'utf8', flag: 'r' });
     envFileContents = envFileContents.replace(/^APP_NAME=.*$/m, `APP_NAME=${to.constant(this.answers.name)}`);
     envFileContents = envFileContents.replace(/^APP_KEY=.*$/m, `APP_KEY=${randomstring.generate()}`);

package/generators/client/react.inc.js

@@ -3,7 +3,7 @@ import pluralize from 'pluralize';
 import { getModelRelatedEntities } from './utils/getModelRelatedEntities.js';
 import { getModelForeignIds } from './utils/getModelForeignIds.js';
 import { getLanguageData } from './config/languages.js';
-
+import { AcRule } from '../utils/AcRule.js';
 const colors = [
     "lime",
     "green",
@@ -43,15 +43,20 @@ export async function createReactClient(that, parsedJDL) {
     that.fs.copyTpl(that.templatePath('react/vite.config.ts.ejs'), that.destinationPath('client/vite.config.ts'), {});
 
     for (const lang of languages) {
-        that.fs.copyTpl(that.templatePath(`react/public/locales/${lang}.json.ejs`), that.destinationPath(`client/public/locales/${lang}/common.json`), { appName });
-        that.fs.copyTpl(that.templatePath(`react/public/locales/entities.json.ejs`), that.destinationPath(`client/public/locales/${lang}/entities.json`), { entities, relationships, to, pluralize, getModelForeignIds, getModelRelatedEntities });
+        that.fs.copyTpl(that.templatePath(`react/public/locales/log/${lang}.json`), that.destinationPath(`client/public/locales/${lang}/log.json`), { appName });
+        that.fs.copyTpl(that.templatePath(`react/public/locales/audit/${lang}.json`), that.destinationPath(`client/public/locales/${lang}/audit.json`), { appName });
+        that.fs.copyTpl(that.templatePath(`react/public/locales/common/${lang}.json.ejs`), that.destinationPath(`client/public/locales/${lang}/common.json`), { appName });
+        that.fs.copyTpl(that.templatePath(`react/public/locales/entities/entities.json.ejs`), that.destinationPath(`client/public/locales/${lang}/entities.json`), { entities: [AcRule, ...entities], relationships, to, pluralize, getModelForeignIds, getModelRelatedEntities });
     };
+    that.fs.copyTpl(that.templatePath("react/public/fonts/material-symbols-outlined.woff2"), that.destinationPath(`client/public/fonts/material-symbols-outlined.woff2`));
+    that.fs.copyTpl(that.templatePath("react/public/fonts/material-symbols-rounded.woff2"), that.destinationPath(`client/public/fonts/material-symbols-rounded.woff2`));
+    that.fs.copyTpl(that.templatePath("react/public/fonts/material-symbols-sharp.woff2"), that.destinationPath(`client/public/fonts/material-symbols-sharp.woff2`));
     that.fs.copyTpl(that.templatePath("react/public/fonts/IBMPlexMono-Regular.ttf"), that.destinationPath(`client/public/fonts/IBMPlexMono-Regular.ttf`));
     that.fs.copyTpl(that.templatePath("react/public/fonts/InterVariable-Italic.woff2"), that.destinationPath(`client/public/fonts/InterVariable-Italic.woff2`));
     that.fs.copyTpl(that.templatePath("react/public/fonts/InterVariable.woff2"), that.destinationPath(`client/public/fonts/InterVariable.woff2`));
 
     that.fs.copyTpl(that.templatePath("react/src/App.css.ejs"), that.destinationPath(`client/src/App.css`), {});
-    that.fs.copyTpl(that.templatePath("react/src/App.tsx.ejs"), that.destinationPath(`client/src/App.tsx`), { entities, to, pluralize });
+    that.fs.copyTpl(that.templatePath("react/src/App.tsx.ejs"), that.destinationPath(`client/src/App.tsx`), { entities: [...entities, AcRule], to, pluralize });
     that.fs.copyTpl(that.templatePath("react/src/i18n.js.ejs"), that.destinationPath(`client/src/i18n.js`), {
         supportedLngs: JSON.stringify(languages).replaceAll(`"`, `'`),
         fallbackLng: nativeLanguage
@@ -108,6 +113,7 @@ export async function createReactClient(that, parsedJDL) {
     that.fs.copyTpl(that.templatePath("react/src/components/formElements/UrlField.tsx.ejs"), that.destinationPath(`client/src/components/formElements/UrlField.tsx`), {});
     that.fs.copyTpl(that.templatePath("react/src/components/formElements/UuidField.tsx.ejs"), that.destinationPath(`client/src/components/formElements/UuidField.tsx`), {});
     that.fs.copyTpl(that.templatePath("react/src/components/HtmlViewer.tsx.ejs"), that.destinationPath(`client/src/components/HtmlViewer.tsx`), {});
+    that.fs.copyTpl(that.templatePath("react/src/components/Icon.tsx.ejs"), that.destinationPath(`client/src/components/Icon.tsx`), {});
     that.fs.copyTpl(that.templatePath("react/src/components/JsonPrint.tsx.ejs"), that.destinationPath(`client/src/components/JsonPrint.tsx`), {});
     that.fs.copyTpl(that.templatePath("react/src/components/LangSelect.tsx.ejs"), that.destinationPath(`client/src/components/LangSelect.tsx`), { to });
     that.fs.copyTpl(that.templatePath("react/src/components/LoginButton.tsx.ejs"), that.destinationPath(`client/src/components/LoginButton.tsx`), {});
@@ -140,12 +146,15 @@ export async function createReactClient(that, parsedJDL) {
     that.fs.copyTpl(that.templatePath("react/src/pages/errors/Err403.tsx.ejs"), that.destinationPath(`client/src/pages/errors/Err403.tsx`), {});
     that.fs.copyTpl(that.templatePath("react/src/pages/errors/Err404.tsx.ejs"), that.destinationPath(`client/src/pages/errors/Err404.tsx`), {});
 
+    that.fs.copyTpl(that.templatePath("react/src/pages/server-logs/LogViewer.tsx.ejs"), that.destinationPath(`client/src/pages/server-logs/LogViewer.tsx`), {});
+
     that.fs.copyTpl(that.templatePath("react/src/hooks/useAuthState.ts.ejs"), that.destinationPath(`client/src/hooks/useAuthState.ts`), {});
     that.fs.copyTpl(that.templatePath("react/src/hooks/useAutoShortcuts.tsx.ejs"), that.destinationPath(`client/src/hooks/useAutoShortcuts.tsx`), {});
     that.fs.copyTpl(that.templatePath("react/src/hooks/useRoles.ts.ejs"), that.destinationPath(`client/src/hooks/useRoles.ts`), {});
 
     that.fs.copyTpl(that.templatePath("react/src/shared/axiosInstance.ts.ejs"), that.destinationPath(`client/src/shared/axiosInstance.ts`));
     that.fs.copyTpl(that.templatePath("react/src/shared/axiosInterceptors.ts.ejs"), that.destinationPath(`client/src/shared/axiosInterceptors.ts`));
+    that.fs.copyTpl(that.templatePath("react/src/shared/entitiesIcons.tsx.ejs"), that.destinationPath(`client/src/shared/entitiesIcons.tsx`), { entities });
     that.fs.copyTpl(that.templatePath("react/src/shared/model/ac-rule.model.ts.ejs"), that.destinationPath(`client/src/shared/model/ac-rule.model.ts`));
 
     for (const entity of entities) {
@@ -166,13 +175,17 @@ export async function createReactClient(that, parsedJDL) {
         that.fs.copyTpl(that.templatePath("react/src/shared/model/enumerations/enumeration.model.ts.ejs"), that.destinationPath(`client/src/shared/model/enumerations/${to.slug(enumeration.name)}.model.ts`), { enumeration });
     }
 
-    that.fs.copyTpl(that.templatePath("react/src/pages/entities/AcRuleList.tsx.ejs"), that.destinationPath(`client/src/pages/entities/AcRuleList.tsx`));
-    that.fs.copyTpl(that.templatePath("react/src/pages/entities/AcRuleView.tsx.ejs"), that.destinationPath(`client/src/pages/entities/AcRuleView.tsx`));
-    that.fs.copyTpl(that.templatePath("react/src/pages/entities/AcRuleEdit.tsx.ejs"), that.destinationPath(`client/src/pages/entities/AcRuleEdit.tsx`));
-    that.fs.copyTpl(that.templatePath("react/src/components/entities/AcRuleForm.tsx.ejs"), that.destinationPath(`client/src/components/entities/AcRuleForm.tsx`));
-    that.fs.copyTpl(that.templatePath("react/src/components/entities/AcRuleDeleteButton.tsx.ejs"), that.destinationPath(`client/src/components/entities/AcRuleDeleteButton.tsx`));
+    that.fs.copyTpl(that.templatePath("react/src/pages/audit/Audits.tsx.ejs"), that.destinationPath(`client/src/pages/audit/Audits.tsx`));
+    that.fs.copyTpl(that.templatePath("react/src/pages/audit/AuditHistory.tsx.ejs"), that.destinationPath(`client/src/pages/audit/AuditHistory.tsx`));
+    that.fs.copyTpl(that.templatePath("react/src/pages/audit/AuditList.tsx.ejs"), that.destinationPath(`client/src/pages/audit/AuditList.tsx`));
+    that.fs.copyTpl(that.templatePath("react/src/pages/audit/AuditStatistics.tsx.ejs"), that.destinationPath(`client/src/pages/audit/AuditStatistics.tsx`));
+    that.fs.copyTpl(that.templatePath("react/src/pages/audit/AuditUserActivity.tsx.ejs"), that.destinationPath(`client/src/pages/audit/AuditUserActivity.tsx`));
+    that.fs.copyTpl(that.templatePath("react/src/pages/audit/AuditView.tsx.ejs"), that.destinationPath(`client/src/pages/audit/AuditView.tsx`));
 
-    for (const entity of entities) {
+    for (const entity of [AcRule, ...entities]) {
+        const hasSoftDelete = entity.annotations?.some(
+            ann => ann.optionName === 'softDelete' && ann.type === 'UNARY'
+        );
         that.fs.copyTpl(
             that.templatePath("react/src/pages/entities/EntityList.tsx.ejs"),
             that.destinationPath(`client/src/pages/entities/${entity.name}List.tsx`),
@@ -187,6 +200,22 @@ export async function createReactClient(that, parsedJDL) {
                 relatedEntities: getModelRelatedEntities(entity, relationships),
                 searchEngine,
             });
+        if (hasSoftDelete) {
+            that.fs.copyTpl(
+                that.templatePath("react/src/pages/entities/EntityTrash.tsx.ejs"),
+                that.destinationPath(`client/src/pages/entities/${entity.name}Trash.tsx`),
+                {
+                    entity,
+                    to,
+                    pluralize,
+                    columns: entity.body.map(c => to.snake(c.name)),
+                    durationColumns: entity.body.filter(c => c.type === 'Duration').map(c => to.snake(c.name)),
+                    fileColumns: entity.body.filter(c => c.type === 'Blob' || c.type === 'AnyBlob' || c.type === 'ImageBlob').map(c => to.snake(c.name)),
+                    foreignIds: getModelForeignIds(entity, relationships),
+                    relatedEntities: getModelRelatedEntities(entity, relationships),
+                    searchEngine,
+                });
+        }
         that.fs.copyTpl(
             that.templatePath("react/src/pages/entities/EntityView.tsx.ejs"),
             that.destinationPath(`client/src/pages/entities/${entity.name}View.tsx`),

package/generators/client/templates/react/index.html.ejs

@@ -2,9 +2,12 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <link rel="icon" type="image/svg+xml" href="/icon.svg">
   <link rel="icon" type="image/png" href="/icon.png">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <link rel="preload" href="/fonts/material-symbols-outlined.woff2" as="font" type="font/woff2" crossorigin="anonymous" />
+  <link rel="preload" href="/fonts/material-symbols-rounded.woff2" as="font" type="font/woff2" crossorigin="anonymous" />
+  <link rel="preload" href="/fonts/material-symbols-sharp.woff2" as="font" type="font/woff2" crossorigin="anonymous" />
   <title><%= appName %></title>
   <script>
     if (!localStorage.getItem('dark-mode')) {