daevin 1.0.0

package/bin/classes/Containers/ReadMe.js

@@ -0,0 +1,212 @@
+import Helpers from "../Helpers.js";
+import chalk from "chalk";
+
+
+
+class ReadMe{
+
+    PROJECT_DIR = ''
+    static generateReadMeFile(table, PROJECT_DIR){
+        console.log(`${chalk.yellow.bold(Helpers.capitalise(table.table_name))} : ${chalk.green.bold('ReadeMe ')} : Generating ReadMe Files`)
+        ReadMe.PROJECT_DIR = PROJECT_DIR;
+        let file_data = `
+### Apiato ${Helpers.capitalise(table.table_name)} Container
+
+This is the Apiato ${Helpers.capitalise(table.table_name)} Container.
+
+#### Table of contents
+
+- [Available Actions](#available-actions)
+- [Available Requests](#available-requests)
+- [Available Tasks](#available-tasks)
+- [Available Models](#available-models)
+- [Available Transformers](#available-transformers)
+- [Available Repositories](#available-repositories)
+- [Available Routes](#available-routes)
+- [Available Tests](#available-tests)
+- [Available Policies](#available-policies)
+- [Available Seeds](#available-seeds)
+- [Available Factories](#available-factories)
+- [Available Migrations](#available-migrations)
+- [Available Events](#available-events)
+- [Available Listeners](#available-listeners)
+- [Available Jobs](#available-jobs)
+- [Available Notifications](#available-notifications)
+
+
+
+#### Available Actions
+
+| Action | Endpoint | Method | Description |
+| ------ | ------ | ------ | ------ |
+| ${Helpers.capitalise(table.table_name)} | /v1/${table.table_name} | GET | Get all ${table.table_name} |
+| ${Helpers.capitalise(table.table_name)} | /v1/${table.table_name}/:id | GET | Get ${table.table_name} by id |
+| ${Helpers.capitalise(table.table_name)} | /v1/${table.table_name} | POST | Create ${table.table_name} |
+| ${Helpers.capitalise(table.table_name)} | /v1/${table.table_name}/:id | PUT | Update ${table.table_name} by id |
+| ${Helpers.capitalise(table.table_name)} | /v1/${table.table_name}/:id | DELETE | Delete ${table.table_name} by id |
+
+#### Available Requests
+
+| Request | Description |
+| ------ | ------ |
+| GetAll${Helpers.capitalise(table.table_name)}Request | Get all ${table.table_name} |
+| Find${Helpers.capitalise(table.table_name)}ByIdRequest | Get ${table.table_name} by id |
+| Create${Helpers.capitalise(table.table_name)}Request | Create ${table.table_name} |
+| Update${Helpers.capitalise(table.table_name)}Request | Update ${table.table_name} by id |
+| Delete${Helpers.capitalise(table.table_name)}Request | Delete ${table.table_name} by id |
+
+#### Available Tasks
+
+| Task | Description |
+| ------ | ------ |
+| GetAll${Helpers.capitalise(table.table_name)}Task | Get all ${table.table_name} |
+| Find${Helpers.capitalise(table.table_name)}ByIdTask | Get ${table.table_name} by id |
+| Create${Helpers.capitalise(table.table_name)}Task | Create ${table.table_name} |
+| Update${Helpers.capitalise(table.table_name)}Task | Update ${table.table_name} by id |
+| Delete${Helpers.capitalise(table.table_name)}Task | Delete ${table.table_name} by id |
+
+#### Available Models
+
+| Model | Description |
+| ------ | ------ |
+| ${Helpers.capitalise(table.table_name)} | ${table.table_name} model |
+
+#### Available Transformers
+
+| Transformer | Description |
+| ------ | ------ |
+| ${Helpers.capitalise(table.table_name)}Transformer | ${table.table_name} transformer |
+
+#### Available Repositories
+
+| Repository | Description |
+| ------ | ------ |
+| ${Helpers.capitalise(table.table_name)}Repository | ${table.table_name} repository |
+
+#### Available Routes
+
+| Route | Description |
+| ------ | ------ |
+| api.${table.table_name}.get | Get all ${table.table_name} |
+| api.${table.table_name}.find | Get ${table.table_name} by id |
+| api.${table.table_name}.create | Create ${table.table_name} |
+| api.${table.table_name}.update | Update ${table.table_name} by id |
+| api.${table.table_name}.delete | Delete ${table.table_name} by id |
+
+#### Available Tests
+
+| Test | Description |
+| ------ | ------ |
+| GetAll${Helpers.capitalise(table.table_name)}Test | Get all ${table.table_name} |
+| Find${Helpers.capitalise(table.table_name)}ByIdTest | Get ${table.table_name} by id |
+| Create${Helpers.capitalise(table.table_name)}Test | Create ${table.table_name} |
+| Update${Helpers.capitalise(table.table_name)}Test | Update ${table.table_name} by id |
+| Delete${Helpers.capitalise(table.table_name)}Test | Delete ${table.table_name} by id |
+
+#### Available Policies
+
+| Policy | Description |
+| ------ | ------ |
+| GetAll${Helpers.capitalise(table.table_name)}Policy | Get all ${table.table_name} |
+
+
+#### Available Seeds
+
+| Seed | Description |
+| ------ | ------ |
+
+#### Available Factories
+
+| Factory | Description |
+| ------ | ------ |
+
+#### Available Migrations
+
+| Migration | Description |
+| ------ | ------ |
+    
+#### Available Events
+
+| Event | Description |
+| ------ | ------ |
+
+
+#### Available Listeners
+
+| Listener | Description |
+| ------ | ------ |
+
+
+#### Available Jobs
+    
+| Job | Description |
+| ------ | ------ |
+
+#### Available Notifications
+
+| Notification | Description |
+| ------ | ------ |
+
+#### Available Mail
+
+| Mail | Description |
+| ------ | ------ |
+
+#### Available Exceptions
+
+| Exception | Description |
+| ------ | ------ |
+
+### Examples
+
+#### Get all ${table.table_name}
+
+    GET /v1/${table.table_name}
+    
+    // Response
+    
+    {
+        "data": [
+            {
+                "id": 1,
+                "name": "John Doe",
+                "email": "test@test.com",
+                "created_at": "2020-01-01 00:00:00",
+            }
+        ]
+    }
+    json
+    
+#### Get ${table.table_name} by id
+    
+        GET /v1/${table.table_name}/1
+        
+        // Response
+    
+       {
+        "data": [
+            {
+                "id": 1,
+                "name": "John Doe",
+                "email": "test@test.com",
+                "created_at": "2020-01-01 00:00:00",
+            }
+        ]
+    }
+    
+### Javascript Example
+
+\`\`\`javascript
+const response = await axios.get('/v1/${table.table_name}/1');
+
+console.log(response.data);
+
+\`\`\`
+
+`;
+        Helpers.writeToFile(`${ReadMe.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}`, `README.md`, file_data)
+
+    }
+}
+
+export default ReadMe;

package/bin/classes/Containers/Repository.js

@@ -0,0 +1,54 @@
+import Helpers from "../Helpers.js";
+import chalk from "chalk";
+
+
+
+class Repository{
+
+    PROJECT_DIR = ''
+    static  generateRepositoryFolder(table, PROJECT_DIR){
+        console.log(`${chalk.yellow.bold(Helpers.capitalise(table.table_name))} : ${chalk.green.bold('Repository ')} : Generating Repository Files`)
+        Repository.PROJECT_DIR = PROJECT_DIR;
+        Helpers.createPath(`${PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/Data/Repositories`);
+        this.generateRepositoryFile(table);
+    }
+
+     static generateRepositoryFile(table) {
+
+        let file_data = `<?php 
+
+namespace App\\Containers\\AppSection\\${Helpers.capitalise(table.table_name)}\\Data\\Repositories;
+
+use App\\Ship\\Parents\\Repositories\\Repository as ParentRepository;
+
+class ${Helpers.capitalise(table.table_name)}Repository extends ParentRepository
+{
+    /**
+     * @var array
+     */
+    protected $fieldSearchable = [
+        ${this.getFieldSearchable(table)}
+    ];
+}
+
+        `;
+
+         Helpers.writeToFile(`${Repository.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/Data/Repositories`, `${Helpers.capitalise(table.table_name)}Repository.php`, file_data)
+
+     }
+
+     static getFieldSearchable(table){
+         let searchable = [];
+         searchable.push(`"id" => "="`);
+         table.columns.forEach(column => {
+             if(column.is_searchable){
+                 searchable.push(`"${column.column_name}" => ${column.type === "string" ? '"like"' : '"="'}`);
+             }
+         });
+
+         return searchable.join(",\r\t\t");
+     }
+
+}
+
+export default Repository;

package/bin/classes/Containers/Request.js

@@ -0,0 +1,341 @@
+import Helpers from "../Helpers.js";
+import chalk from "chalk";
+
+
+
+class Request{
+
+    PROJECT_DIR = ''
+    static  generateRequestFolder(table, PROJECT_DIR){
+        console.log(`${chalk.yellow.bold(Helpers.capitalise(table.table_name))} : ${chalk.green.bold('Requests ')} : Generating Request Files`)
+        Request.PROJECT_DIR = PROJECT_DIR
+        Helpers.createPath(`${Request.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/UI/API/Requests`);
+        Request.generateAllRequestFiles(table);
+    }
+
+    static generateAllRequestFiles(table){
+        Request.generateCreateRequest(table);
+        Request.generateDeleteRequest(table);
+        Request.generateGetAllRequest(table);
+        Request.generateFindByIdRequest(table);
+        Request.generateUpdateRequest(table);
+    }
+
+     static generateCreateRequest(table) {
+
+        let file_data = `<?php
+        
+namespace App\\Containers\\AppSection\\${Helpers.capitalise(table.table_name)}\\UI\\API\\Requests;
+
+use App\\Ship\\Parents\\Requests\\Request;
+
+class Create${Helpers.capitalise(table.table_name)}Request extends Request
+{
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => '',
+        'roles'       => '',
+    ];
+
+    /**
+     * Id's that needs decoding before applying the validation rules.
+     */
+    protected array $decode = [
+        // 'id',
+    ];
+
+    /**
+     * Defining the URL parameters (e.g, \`/user/{id}\`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+        // 'id',
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+            ${Request.getRequestproperties(table)}
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}        
+        `;
+
+        Helpers.writeToFile(`${Request.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/UI/API/Requests`, `Create${Helpers.capitalise(table.table_name)}Request.php`, file_data)
+
+    }
+
+     static generateDeleteRequest(table) {
+        let file_data = `<?php
+        
+namespace App\\Containers\\AppSection\\${Helpers.capitalise(table.table_name)}\\UI\\API\\Requests;
+
+use App\\Ship\\Parents\\Requests\\Request;
+
+class Delete${Helpers.capitalise(table.table_name)}Request extends Request
+{
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => '',
+        'roles'       => '',
+    ];
+
+    /**
+     * Id's that needs decoding before applying the validation rules.
+     */
+    protected array $decode = [
+         'id',
+    ];
+
+    /**
+     * Defining the URL parameters (e.g, \`/user/{id}\`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+         'id',
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+            'id' => 'required'
+            // 'deleted'=>'required',
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}
+ 
+        `;
+
+        Helpers.writeToFile(`${Request.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/UI/API/Requests`, `Delete${Helpers.capitalise(table.table_name)}Request.php`, file_data)
+
+    }
+
+     static generateGetAllRequest(table) {
+
+        let file_data = `<?php 
+        
+namespace App\\Containers\\AppSection\\${Helpers.capitalise(table.table_name)}\\UI\\API\\Requests;
+
+use App\\Ship\\Parents\\Requests\\Request;
+
+class GetAll${Helpers.capitalise(table.table_name)}Request extends Request
+{
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => '',
+        'roles'       => '',
+    ];
+
+    /**
+     * Id's that needs decoding before applying the validation rules.
+     */
+    protected array $decode = [
+         //'id',
+    ];
+
+    /**
+     * Defining the URL parameters (e.g, \`/user/{id}\`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+         //'id',
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+           // 'id' => 'required'
+            // 'deleted'=>'required',
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}
+
+        `;
+
+        Helpers.writeToFile(`${Request.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/UI/API/Requests`, `GetAll${Helpers.capitalise(table.table_name)}Request.php`, file_data)
+
+
+    }
+
+     static generateUpdateRequest(table) {
+
+        let file_data = `<?php
+
+namespace App\\Containers\\AppSection\\${Helpers.capitalise(table.table_name)}\\UI\\API\\Requests;
+
+use App\\Ship\\Parents\\Requests\\Request;
+
+class Update${Helpers.capitalise(table.table_name)}Request extends Request
+{
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => '',
+        'roles'       => '',
+    ];
+
+    /**
+     * Id's that needs decoding before applying the validation rules.
+     */
+    protected array $decode = [
+         'id',
+    ];
+
+    /**
+     * Defining the URL parameters (e.g, \`/user/{id}\`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+         'id',
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+            'id' => 'required',
+            ${Request.getRequestproperties(table, true)}
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}
+
+        `;
+
+        Helpers.writeToFile(`${Request.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/UI/API/Requests`, `Update${Helpers.capitalise(table.table_name)}Request.php`, file_data)
+
+    }
+
+     static generateFindByIdRequest(table) {
+
+        let file_data = `<?php
+        
+namespace App\\Containers\\AppSection\\${Helpers.capitalise(table.table_name)}\\UI\\API\\Requests;
+
+use App\\Ship\\Parents\\Requests\\Request;
+
+class Find${Helpers.capitalise(table.table_name)}ByIdRequest extends Request
+{
+    /**
+     * Define which Roles and/or Permissions has access to this request.
+     */
+    protected array $access = [
+        'permissions' => '',
+        'roles'       => '',
+    ];
+
+    /**
+     * Id's that needs decoding before applying the validation rules.
+     */
+    protected array $decode = [
+         'id',
+    ];
+
+    /**
+     * Defining the URL parameters (e.g, \`/user/{id}\`) allows applying
+     * validation rules on them and allows accessing them like request data.
+     */
+    protected array $urlParameters = [
+         'id',
+    ];
+
+    /**
+     * Get the validation rules that apply to the request.
+     */
+    public function rules(): array
+    {
+        return [
+            'id' => 'required'
+        ];
+    }
+
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return $this->check([
+            'hasAccess',
+        ]);
+    }
+}
+
+        `;
+
+        Helpers.writeToFile(`${Request.PROJECT_DIR}/Containers/AppSection/${Helpers.capitalise(table.table_name)}/UI/API/Requests`, `Find${Helpers.capitalise(table.table_name)}ByIdRequest.php`, file_data)
+
+    }
+
+    static getRequestproperties(table, nullable = false){
+        let properties = [];
+        table.columns.forEach(column => {
+            if(column.column_name === 'id' || column.column_name === 'created_at' || column.column_name === 'updated_at' || column.column_name === 'deleted_at')
+                return;
+
+            if(column.hasOwnProperty('properties') && column.properties.length > 0)
+                properties.push(`'${column.column_name}' => '${nullable ? 'nullable|' : ''}${column.properties.join("|")}'`);
+        });
+        return properties.join(",\n\t\t\t");
+    }
+
+
+}
+
+export default Request;