@arikajs/cli 0.0.1

package/dist/tests/Cli.test.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const node_assert_1 = __importDefault(require("node:assert"));
+const src_1 = require("../src");
+(0, node_test_1.describe)('CLI Bootstrap', () => {
+    (0, node_test_1.it)('boots correctly and returns a CommandRegistry', async () => {
+        const registry = await src_1.Bootstrap.boot();
+        node_assert_1.default.ok(registry !== null);
+        node_assert_1.default.strictEqual(typeof registry.run, 'function');
+    });
+});
+//# sourceMappingURL=Cli.test.js.map

package/dist/tests/Cli.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cli.test.js","sourceRoot":"","sources":["../../tests/Cli.test.ts"],"names":[],"mappings":";;;;;AACA,yCAA+C;AAC/C,8DAAiC;AACjC,gCAAmC;AAEnC,IAAA,oBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,IAAA,cAAE,EAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,QAAQ,GAAG,MAAM,eAAS,CAAC,IAAI,EAAE,CAAC;QACxC,qBAAM,CAAC,EAAE,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC;QAC7B,qBAAM,CAAC,WAAW,CAAC,OAAO,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@arikajs/cli",
+  "version": "0.0.1",
+  "description": "The command-line interface for the ArikaJS framework.",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "arika": "dist/bin/arika.js"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && chmod +x dist/bin/arika.js",
+    "build:tests": "tsc -p tsconfig.test.json",
+    "clean": "rm -rf dist",
+    "prepare": "echo skip",
+    "test": "npm run build && npm run build:tests && node --test 'dist/tests/**/*.test.js'",
+    "test:watch": "npm run build && npm run build:tests && node --test --watch 'dist/tests/**/*.test.js'"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "keywords": [
+    "arika",
+    "arika-js",
+    "cli",
+    "console",
+    "scaffolding"
+  ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arikajs/cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/arikajs/cli/issues"
+  },
+  "homepage": "https://github.com/arikajs/cli#readme",
+  "dependencies": {
+    "@arikajs/console": "^0.0.1",
+    "@arikajs/database": "^0.0.1",
+    "@arikajs/docs": "^0.0.1",
+    "inquirer": "^8.2.7",
+    "dotenv": "^16.4.5"
+  },
+  "devDependencies": {
+    "@types/dotenv": "^8.2.3",
+    "@types/inquirer": "^8.2.12",
+    "@types/node": "^20.11.24",
+    "typescript": "^5.3.3"
+  },
+  "author": "Prakash Tank"
+}

package/templates/app/.env.example

@@ -0,0 +1,47 @@
+APP_NAME=ArikaApp
+APP_ENV=development
+APP_PORT=3000
+APP_DEBUG=true
+APP_KEY=
+APP_URL=http://localhost:3000
+APP_TIMEZONE=UTC
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=arikajs
+DB_USERNAME=root
+DB_PASSWORD=
+
+REDIS_CLIENT=ioredis
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+REDIS_DB=0
+
+MAIL_MAILER=log
+MAIL_HOST=127.0.0.1
+MAIL_PORT=2525
+MAIL_USERNAME=
+MAIL_PASSWORD=
+MAIL_ENCRYPTION=tls
+MAIL_FROM_ADDRESS="hello@example.com"
+MAIL_FROM_NAME="${APP_NAME}"
+
+FILESYSTEM_DISK=local
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_URL=
+AWS_ENDPOINT=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+LOG_CHANNEL=stack
+LOG_LEVEL=debug
+
+QUEUE_CONNECTION=sync
+
+CACHE_STORE=database
+CACHE_PREFIX=arika_cache

package/templates/app/app/Controllers/UserController.ts

@@ -0,0 +1,88 @@
+import { User } from '../Models/User';
+
+export class UserController {
+    /**
+     * Display a listing of users.
+     */
+    async index(req: any, res: any) {
+        const users = await User.all();
+        return res.json(users);
+    }
+
+    /**
+     * Display the specified user.
+     */
+    async show(req: any, res: any) {
+        const user = await User.find(req.params.id);
+
+        if (!user) {
+            return res.status(404).json({
+                message: 'User not found'
+            });
+        }
+
+        return res.json(user);
+    }
+
+    /**
+     * Store a newly created user.
+     */
+    async store(req: any, res: any) {
+        const { name, email, password } = req.body;
+
+        // Basic validation
+        if (!name || !email || !password) {
+            return res.status(400).json({
+                message: 'Name, email, and password are required'
+            });
+        }
+
+        const user = await User.create({
+            name,
+            email,
+            password
+        });
+
+        return res.status(201).json(user);
+    }
+
+    /**
+     * Update the specified user.
+     */
+    async update(req: any, res: any) {
+        const user = await User.find(req.params.id);
+
+        if (!user) {
+            return res.status(404).json({
+                message: 'User not found'
+            });
+        }
+
+        const { name, email, password } = req.body;
+
+        await user.update({
+            ...(name && { name }),
+            ...(email && { email }),
+            ...(password && { password })
+        });
+
+        return res.json(user);
+    }
+
+    /**
+     * Remove the specified user.
+     */
+    async destroy(req: any, res: any) {
+        const user = await User.find(req.params.id);
+
+        if (!user) {
+            return res.status(404).json({
+                message: 'User not found'
+            });
+        }
+
+        await user.delete();
+
+        return res.status(204).send();
+    }
+}

package/templates/app/app/Http/Kernel.ts

@@ -0,0 +1,18 @@
+import { Kernel as BaseKernel } from 'arikajs';
+
+export class Kernel extends BaseKernel {
+    /**
+     * The application's route middleware groups.
+     */
+    protected middlewareGroups = {
+        web: [],
+        api: [],
+    };
+
+    /**
+     * The application's route middleware aliases.
+     */
+    protected routeMiddleware = {
+        'auth': (request: any, next: any) => next(request), // dummy for now
+    };
+}

package/templates/app/app/Models/User.ts

@@ -0,0 +1,15 @@
+import { Model } from 'arikajs';
+
+export class User extends Model {
+    static table = 'users';
+
+    static fillable = [
+        'name',
+        'email',
+        'password'
+    ];
+
+    static hidden = [
+        'password'
+    ];
+}

package/templates/app/bootstrap/app.ts

@@ -0,0 +1,13 @@
+import { createApp } from 'arikajs';
+import path from 'path';
+
+const app = createApp(
+    path.resolve(__dirname, '../')
+);
+
+import { Kernel } from '../app/Http/Kernel';
+import { Kernel as BaseKernel } from 'arikajs';
+
+app.singleton(BaseKernel, () => new Kernel(app));
+
+export default app;

package/templates/app/config/app.ts

@@ -0,0 +1,9 @@
+
+export default {
+    name: process.env.APP_NAME || 'ArikaJS',
+    env: process.env.APP_ENV || 'production',
+    debug: process.env.APP_DEBUG === 'true',
+    url: process.env.APP_URL || 'http://localhost',
+    timezone: process.env.APP_TIMEZONE || 'UTC',
+    key: process.env.APP_KEY,
+};

package/templates/app/config/cache.ts

@@ -0,0 +1,37 @@
+export default {
+    /**
+     * Default Cache Store
+     */
+    default: process.env.CACHE_STORE || 'database',
+
+    /**
+     * Cache Stores
+     */
+    stores: {
+        memory: {
+            driver: 'memory',
+        },
+
+        database: {
+            driver: 'database',
+            table: 'cache',
+            connection: null,
+            lock_connection: null,
+        },
+
+        redis: {
+            driver: 'redis',
+            connection: 'default',
+            mode: process.env.REDIS_MODE || 'standalone', // standalone, sentinel, cluster
+            host: process.env.REDIS_HOST || '127.0.0.1',
+            password: process.env.REDIS_PASSWORD || null,
+            port: process.env.REDIS_PORT || 6379,
+            database: process.env.REDIS_DB || 0,
+        },
+    },
+
+    /**
+     * Cache Key Prefix
+     */
+    prefix: process.env.CACHE_PREFIX || 'arika_cache',
+};

package/templates/app/config/database.ts

@@ -0,0 +1,36 @@
+
+export default {
+    default: process.env.DB_CONNECTION || 'sqlite',
+
+    connections: {
+        sqlite: {
+            client: 'sqlite3',
+            connection: {
+                filename: process.env.DB_DATABASE || './database.sqlite'
+            },
+            useNullAsDefault: true
+        },
+
+        mysql: {
+            client: 'mysql2',
+            connection: {
+                host: process.env.DB_HOST || '127.0.0.1',
+                port: parseInt(process.env.DB_PORT || '3306'),
+                database: process.env.DB_DATABASE || 'arika',
+                user: process.env.DB_USERNAME || 'root',
+                password: process.env.DB_PASSWORD || ''
+            }
+        },
+
+        postgres: {
+            client: 'pg',
+            connection: {
+                host: process.env.DB_HOST || '127.0.0.1',
+                port: parseInt(process.env.DB_PORT || '5432'),
+                database: process.env.DB_DATABASE || 'arika',
+                user: process.env.DB_USERNAME || 'postgres',
+                password: process.env.DB_PASSWORD || ''
+            }
+        }
+    }
+};

package/templates/app/config/filesystems.ts

@@ -0,0 +1,33 @@
+export default {
+    /**
+     * Default Filesystem Disk
+     */
+    default: process.env.FILESYSTEM_DISK || 'local',
+
+    /**
+     * Filesystem Disks
+     */
+    disks: {
+        local: {
+            driver: 'local',
+            root: './storage/app',
+        },
+
+        public: {
+            driver: 'local',
+            root: './storage/public',
+            url: (process.env.APP_URL || 'http://localhost:3000') + '/storage',
+        },
+
+        s3: {
+            driver: 's3',
+            key: process.env.AWS_ACCESS_KEY_ID,
+            secret: process.env.AWS_SECRET_ACCESS_KEY,
+            region: process.env.AWS_DEFAULT_REGION || 'us-east-1',
+            bucket: process.env.AWS_BUCKET,
+            url: process.env.AWS_URL,
+            endpoint: process.env.AWS_ENDPOINT,
+            forcePathStyle: process.env.AWS_USE_PATH_STYLE_ENDPOINT === 'true',
+        },
+    },
+};

package/templates/app/config/http.ts

@@ -0,0 +1,5 @@
+
+export default {
+    port: parseInt(process.env.APP_PORT || '3000', 10),
+    host: process.env.APP_HOST || '0.0.0.0',
+};

package/templates/app/config/logging.ts

@@ -0,0 +1,35 @@
+export default {
+    /**
+     * Default Log Channel
+     */
+    default: process.env.LOG_CHANNEL || 'stack',
+
+    /**
+     * Log Channels
+     */
+    channels: {
+        stack: {
+            driver: 'stack',
+            channels: ['console', 'single'],
+            ignore_exceptions: false,
+        },
+
+        single: {
+            driver: 'file',
+            path: './storage/logs/arika.log',
+            level: process.env.LOG_LEVEL || 'debug',
+        },
+
+        daily: {
+            driver: 'daily',
+            path: './storage/logs/arika.log',
+            level: process.env.LOG_LEVEL || 'debug',
+            days: 14,
+        },
+
+        console: {
+            driver: 'console',
+            level: process.env.LOG_LEVEL || 'debug',
+        },
+    },
+};

package/templates/app/config/mail.ts

@@ -0,0 +1,27 @@
+export default {
+    default: process.env.MAIL_MAILER || 'log',
+
+    mailers: {
+        smtp: {
+            transport: 'smtp',
+            host: process.env.MAIL_HOST || '127.0.0.1',
+            port: Number(process.env.MAIL_PORT || 2525),
+            encryption: process.env.MAIL_ENCRYPTION || 'tls',
+            username: process.env.MAIL_USERNAME,
+            password: process.env.MAIL_PASSWORD,
+        },
+
+        log: {
+            transport: 'log',
+        },
+
+        array: {
+            transport: 'array',
+        },
+    },
+
+    from: {
+        address: process.env.MAIL_FROM_ADDRESS || 'hello@example.com',
+        name: process.env.MAIL_FROM_NAME || 'Example',
+    },
+};

package/templates/app/config/queue.ts

@@ -0,0 +1,40 @@
+export default {
+    /**
+     * Default Queue Connection Name
+     */
+    default: process.env.QUEUE_CONNECTION || 'sync',
+
+    /**
+     * Queue Connections
+     */
+    connections: {
+        sync: {
+            driver: 'sync',
+        },
+
+        database: {
+            driver: 'database',
+            table: 'jobs',
+            queue: 'default',
+            retry_after: 90,
+            after_commit: false,
+        },
+    },
+
+    /**
+     * Job Batching
+     */
+    batching: {
+        database: process.env.DB_CONNECTION || 'mysql',
+        table: 'job_batches',
+    },
+
+    /**
+     * Failed Queue Jobs
+     */
+    failed: {
+        driver: process.env.QUEUE_FAILED_DRIVER || 'database-uuids',
+        database: process.env.DB_CONNECTION || 'mysql',
+        table: 'failed_jobs',
+    },
+};

package/templates/app/database/migrations/0001_create_users_table.ts

@@ -0,0 +1,23 @@
+import { Migration, SchemaBuilder } from '@arikajs/database';
+
+export default class CreateUsersTable extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public async up(schema: SchemaBuilder): Promise<void> {
+        await schema.create('users', (table: any) => {
+            table.id();
+            table.string('name');
+            table.string('email').unique();
+            table.string('password');
+            table.timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public async down(schema: SchemaBuilder): Promise<void> {
+        await schema.dropIfExists('users');
+    }
+}

package/templates/app/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "rest-api-demo",
+  "version": "1.0.0",
+  "description": "ArikaJS API Project",
+  "private": true,
+  "scripts": {
+    "dev": "arika serve --dev",
+    "start": "arika serve",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "arikajs": "^0.1.4"
+  },
+  "devDependencies": {
+    "@arikajs/cli": "^0.1.4",
+    "typescript": "^5.0.0",
+    "tsx": "^4.0.0",
+    "@types/node": "^20.0.0"
+  },
+  "author": "Prakash Tank"
+}