@h3ravel/core 1.4.0 → 1.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/core",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Core application container, lifecycle management and service providers for H3ravel.",
   "type": "module",
   "main": "./dist/index.js",
@@ -13,6 +13,9 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -39,7 +42,7 @@
     "srvx": "^0.8.2",
     "tslib": "^2.6.0",
     "dotenv": "^17.2.1",
-    "@h3ravel/shared": "^0.16.0"
+    "@h3ravel/shared": "^0.16.4"
   },
   "devDependencies": {
     "typescript": "^5.4.0"

package/CHANGELOG.md

@@ -1,194 +0,0 @@
-# @h3ravel/core
-
-## 1.4.0
-
-### Minor Changes
-
-- 79f4045: feat: add add exports to package.json
-
-### Patch Changes
-
-- Updated dependencies [79f4045]
-  - @h3ravel/shared@0.16.0
-
-## 1.3.0
-
-### Minor Changes
-
-- feat: implement full IoC container resolution
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.15.4
-
-## 1.2.2
-
-### Patch Changes
-
-- feat: add homepage and repository to all packages.
-- Updated dependencies
-  - @h3ravel/shared@0.15.2
-
-## 1.2.1
-
-### Patch Changes
-
-- chore: update readme accros all packages
-- Updated dependencies
-  - @h3ravel/shared@0.15.1
-
-## 1.2.0
-
-### Minor Changes
-
-- d07ff49: feat: reserve the `app.` namespace for generic service provider resolution.
-
-### Patch Changes
-
-- Updated dependencies [d07ff49]
-  - @h3ravel/shared@0.15.0
-
-## 1.1.2
-
-### Patch Changes
-
-- chore: require the latest dependencies from the framework
-
-## 1.1.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.14.0
-
-## 1.1.0
-
-### Minor Changes
-
-- 6e249fe: feat: bind view as a self contained method to render views
-
-### Patch Changes
-
-- Updated dependencies [6e249fe]
-  - @h3ravel/shared@0.13.0
-
-## 1.0.9
-
-### Patch Changes
-
-- chore: regularize all interfaces.
-- Updated dependencies
-  - @h3ravel/shared@0.12.1
-
-## 1.0.8
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.12.0
-
-## 1.0.7
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.11.0
-
-## 1.0.6
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.10.0
-
-## 1.0.5
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.9.0
-
-## 1.0.4
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.8.0
-
-## 1.0.3
-
-### Patch Changes
-
-- chore: add download count to readme
-- Updated dependencies
-  - @h3ravel/shared@0.7.1
-
-## 1.0.2
-
-### Patch Changes
-
-- Updated dependencies [b0d1b7c]
-  - @h3ravel/shared@0.7.0
-
-## 1.0.0
-
-### Major Changes
-
-- b40caeb: feat: make service providers sortable and unique while only loading the core providers by default.
-  Service providers are no longer loaded by default, asides the ones provided by @h3ravel/core
-  Service provides are sorted by an optional order and priority property.
-
-### Patch Changes
-
-- Updated dependencies [b40caeb]
-  - @h3ravel/shared@0.6.0
-
-## 0.5.0
-
-### Minor Changes
-
-- rebuild all dependencies
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.5.0
-
-## 0.4.0
-
-### Minor Changes
-
-- 8ceb2c1: implement the Application class directly since it already implements the IClass contract
-
-### Patch Changes
-
-- a27f452: chore: fix all linting issues.
-- c906050: chore: migrate tests suite to jest
-- Updated dependencies [8ceb2c1]
-- Updated dependencies [a27f452]
-- Updated dependencies [c906050]
-  - @h3ravel/shared@0.4.0
-
-## 0.3.0
-
-### Minor Changes
-
-- 3ff97bf: refactor: add a shared package to be extended by others to avoid cyclic dependency issues.
-
-### Patch Changes
-
-- Updated dependencies [3ff97bf]
-  - @h3ravel/shared@0.3.0
-
-## 0.2.0
-
-### Minor Changes
-
-- aea734f: Fix all known bugs and improved interdependecy between packages.
-
-### Patch Changes
-
-- Updated dependencies [aea734f]
-  - @h3ravel/router@0.2.0
-  - @h3ravel/shared@0.2.0

package/src/Application.ts

@@ -1,215 +0,0 @@
-import { IApplication, IPathName, IServiceProvider } from '@h3ravel/shared'
-
-import { Container } from './Container'
-import { PathLoader } from '@h3ravel/shared'
-import dotenv from 'dotenv'
-import path from 'node:path'
-
-export class Application extends Container implements IApplication {
-    paths = new PathLoader()
-    private booted = false
-    private versions = { app: '0', ts: '0' }
-    private basePath: string
-
-    private providers: IServiceProvider[] = []
-    protected externalProviders: Array<new (_app: Application) => IServiceProvider> = []
-
-    constructor(basePath: string) {
-        super()
-        this.basePath = basePath
-        this.setPath('base', basePath)
-        this.loadOptions()
-        this.registerBaseBindings();
-        dotenv.config({ quiet: true })
-    }
-
-    /**
-     * Register core bindings into the container
-     */
-    protected registerBaseBindings () {
-        this.bind(Application, () => this)
-        this.bind('path.base', () => this.basePath)
-        this.bind('load.paths', () => this.paths)
-    }
-
-    /**
-     * Dynamically register all configured providers
-     */
-    public async registerConfiguredProviders () {
-        const providers = await this.getAllProviders()
-
-        for (const ProviderClass of providers) {
-            if (!ProviderClass) continue
-            const provider = new ProviderClass(this)
-            await this.register(provider)
-        }
-    }
-
-    protected async loadOptions () {
-        const app = await this.safeImport(this.getPath('base', 'package.json'))
-        const core = await this.safeImport('../package.json')
-
-        if (app && app.dependencies) {
-            this.versions.app = app.dependencies['@h3ravel/core']
-        }
-        if (core && core.devDependencies) {
-            this.versions.ts = app.devDependencies.typescript
-        }
-    }
-
-    /**
-     * Load default and optional providers dynamically
-     * 
-     * Auto-Registration Behavior
-     * 
-     * Minimal App: Loads only core, config, http, router by default.
-     * Full-Stack App: Installs database, mail, queue, cache → they self-register via their providers.
-     */
-    protected async getConfiguredProviders (): Promise<Array<new (_app: Application) => IServiceProvider>> {
-        return [
-            (await import('@h3ravel/core')).AppServiceProvider,
-            (await import('@h3ravel/core')).ViewServiceProvider,
-        ]
-    }
-
-    protected async getAllProviders (): Promise<Array<new (_app: Application) => IServiceProvider>> {
-        const coreProviders = await this.getConfiguredProviders();
-        const allProviders = [...coreProviders, ...this.externalProviders];
-
-        /**
-         * Deduplicate by class reference
-         */
-        const uniqueProviders = Array.from(new Set(allProviders));
-
-        return this.sortProviders(uniqueProviders);
-    }
-
-    private sortProviders (providers: Array<new (_app: Application) => IServiceProvider>) {
-        const priorityMap = new Map<string, number>();
-
-        /**
-         * Base priority (default 0)
-         */
-        providers.forEach((Provider) => {
-            priorityMap.set(Provider.name, (Provider as any).priority ?? 0);
-        });
-
-        /**
-         * Handle before/after adjustments
-         */
-        providers.forEach((Provider) => {
-            const order = (Provider as any).order;
-            if (!order) return;
-
-            const [direction, target] = order.split(':');
-            const targetPriority = priorityMap.get(target) ?? 0;
-
-            if (direction === 'before') {
-                priorityMap.set(Provider.name, targetPriority - 1);
-            } else if (direction === 'after') {
-                priorityMap.set(Provider.name, targetPriority + 1);
-            }
-        });
-
-        /**
-         * Sort the service providers based on thier name and priority
-         */
-        const sorted = providers.sort(
-            (A, B) => (priorityMap.get(B.name) ?? 0) - (priorityMap.get(A.name) ?? 0)
-        );
-
-        /**
-         * If debug is enabled, let's show the loaded service provider info
-         */
-        if (process.env.APP_DEBUG === 'true') {
-            console.table(
-                sorted.map((P) => ({
-                    Provider: P.name,
-                    Priority: priorityMap.get(P.name),
-                    Order: (P as any).order || 'N/A',
-                }))
-            );
-        }
-
-        return sorted
-    }
-
-    registerProviders (providers: Array<new (_app: Application) => IServiceProvider>): void {
-        this.externalProviders.push(...providers)
-    }
-
-    /**
-     * Register a provider
-     */
-    public async register (provider: IServiceProvider) {
-        await provider.register()
-        this.providers.push(provider)
-    }
-
-    /**
-     * Boot all providers after registration
-     */
-    public async boot () {
-        if (this.booted) return
-
-        for (const provider of this.providers) {
-            if (provider.boot) {
-                await provider.boot()
-            }
-        }
-
-        this.booted = true
-    }
-
-    /**
-     * Attempt to dynamically import an optional module
-     */
-    private async safeImport (moduleName: string) {
-        try {
-            const mod = await import(moduleName)
-            return mod.default ?? mod ?? {}
-        } catch {
-            return null
-        }
-    }
-
-    /**
-     * Get the base path of the app
-     * 
-     * @returns 
-     */
-    getBasePath (): string {
-        return this.basePath
-    }
-
-    /**
-     * Dynamically retrieves a path property from the class.
-     * Any property ending with "Path" is accessible automatically.
-     *
-     * @param name - The base name of the path property
-     * @returns 
-     */
-    getPath (name: IPathName, pth?: string) {
-        return path.join(this.paths.getPath(name, this.basePath), pth ?? '')
-    }
-
-    /**
-     * Programatically set the paths.
-     *
-     * @param name - The base name of the path property
-     * @param path - The new path
-     * @returns 
-     */
-    setPath (name: IPathName, path: string) {
-        return this.paths.setPath(name, path, this.basePath)
-    }
-
-    /**
-     * Returns the installed version of the system core and typescript.
-     *
-     * @returns 
-     */
-    getVersion (key: 'app' | 'ts') {
-        return this.versions[key]?.replaceAll(/\^|~/g, '')
-    }
-}

package/src/Container.ts

@@ -1,105 +0,0 @@
-import type { Bindings, IContainer, UseKey } from '@h3ravel/shared'
-
-type IBinding = UseKey | (new (..._args: any[]) => unknown)
-
-export class Container implements IContainer {
-    private bindings = new Map<IBinding, () => unknown>()
-    private singletons = new Map<IBinding, unknown>()
-
-    /**
-     * Check if the target has any decorators
-     * 
-     * @param target 
-     * @returns 
-     */
-    static hasAnyDecorator (target: Function): boolean {
-        if (Reflect.getMetadataKeys(target).length > 0) return true
-
-        const paramLength = target.length
-
-        for (let i = 0; i < paramLength; i++) {
-            if (Reflect.getMetadataKeys(target, `__param_${i}`).length > 0) {
-                return true
-            }
-        }
-
-        return false
-    }
-
-    /**
-     * Bind a transient service to the container
-     */
-    bind<T> (key: new (...args: any[]) => T, factory: () => T): void
-    bind<T extends UseKey> (key: T, factory: () => Bindings[T]): void
-    bind<T extends UseKey> (
-        key: T,
-        factory: () => Bindings[T] | T
-    ) {
-        this.bindings.set(key, factory)
-    }
-
-    /**
-     * Bind a singleton service to the container
-     */
-    singleton<T extends UseKey> (
-        key: T | (new (..._args: any[]) => Bindings[T]),
-        factory: () => Bindings[T]
-    ) {
-        this.bindings.set(key, () => {
-            if (!this.singletons.has(key)) {
-                this.singletons.set(key, factory())
-            }
-            return this.singletons.get(key)!
-        })
-    }
-
-    /**
-     * Resolve a service from the container
-     */
-    make<T extends UseKey, X = undefined> (
-        key: T | (new (..._args: any[]) => Bindings[T])
-    ): X extends undefined ? Bindings[T] : X {
-        /**
-         * Direct factory binding
-         */
-        if (this.bindings.has(key)) {
-            return this.bindings.get(key)!() as Bindings[T]
-        }
-
-        /**
-         * If this is a class constructor, auto-resolve via reflection
-         */
-        if (typeof key === 'function') {
-            return this.build(key)
-        }
-
-        throw new Error(
-            `No binding found for key: ${typeof key === 'string' ? key : (key as any)?.name}`
-        )
-    }
-
-    /**
-     * Automatically build a class with constructor dependency injection
-     */
-    private build<T extends UseKey> (ClassType: new (..._args: any[]) => Bindings[T]): Bindings[T] {
-        let dependencies: any[] = [];
-
-        if (Array.isArray((ClassType as any).__inject__)) {
-            dependencies = (ClassType as any).__inject__.map((alias: any) => {
-                return this.make(alias)
-            });
-        } else {
-            const paramTypes: any[] = Reflect.getMetadata('design:paramtypes', ClassType) || []
-            dependencies = paramTypes.map((dep) => this.make(dep))
-        }
-
-        return new ClassType(...dependencies);
-    }
-
-    /**
-     * Check if a service is registered
-     */
-    has (key: UseKey): boolean {
-        return this.bindings.has(key)
-    }
-}

package/src/Contracts/ServiceProviderConstructor.ts

@@ -1,5 +0,0 @@
-import { Application, ServiceProvider } from "..";
-
-import { IServiceProvider } from "@h3ravel/shared";
-
-export type ServiceProviderConstructor = (new (app: Application) => ServiceProvider) & IServiceProvider;

package/src/Controller.ts

@@ -1,20 +0,0 @@
-import { HttpContext, IController } from '@h3ravel/shared'
-
-import { Application } from '.'
-
-/**
- * Base controller class
- */
-export abstract class Controller implements IController {
-    protected app: Application
-
-    constructor(app: Application) {
-        this.app = app
-    }
-
-    public show (_ctx: HttpContext): any { return }
-    public index (_ctx: HttpContext): any { return }
-    public store (_ctx: HttpContext): any { return }
-    public update (_ctx: HttpContext): any { return }
-    public destroy (_ctx: HttpContext): any { return }
-}

package/src/Di/Inject.ts

@@ -1,10 +0,0 @@
-export function Inject (...dependencies: string[]) {
-    return function (target: any) {
-        target.__inject__ = dependencies;
-    };
-}
-
-
-export function Injectable (): ClassDecorator {
-    return (_arget) => { };
-}

package/src/Exceptions/Handler.ts

@@ -1 +0,0 @@
-export default class { }

package/src/Http/Kernel.ts

@@ -1,106 +0,0 @@
-import { HttpContext, IMiddleware } from '@h3ravel/shared'
-
-import type { H3Event } from 'h3'
-
-/**
- * Kernel class handles middleware execution and response transformations.
- * It acts as the core middleware pipeline for HTTP requests.
- */
-export class Kernel {
-    /**
-     * @param context - A factory function that converts an H3Event into an HttpContext.
-     * @param middleware - An array of middleware classes that will be executed in sequence.
-     */
-    constructor(
-        protected context: (event: H3Event) => HttpContext,
-        protected middleware: IMiddleware[] = [],
-    ) { }
-
-    /**
-     * Handles an incoming request and passes it through middleware before invoking the next handler.
-     * 
-     * @param event - The raw H3 event object.
-     * @param next - A callback function that represents the next layer (usually the controller or final handler).
-     * @returns A promise resolving to the result of the request pipeline.
-     */
-    async handle (
-        event: H3Event,
-        next: (ctx: HttpContext) => Promise<unknown>
-    ): Promise<unknown> {
-        /**
-         * Convert the raw event into a standardized HttpContext
-         */
-        const ctx = this.context(event)
-        const { app } = ctx.request
-
-        /**
-         * Dynamically bind the view renderer to the service container.
-         * This allows any part of the request lifecycle to render templates using Edge.
-         */
-        app.bind('view', () => async (template: string, params?: Record<string, any>) => {
-            const edge = app.make('edge')
-            return ctx.response.html(await edge.render(template, params))
-        })
-
-        /**
-         * Run middleware stack and obtain result
-         */
-        const result = await this.runMiddleware(ctx, () => next(ctx))
-
-        /**
-         * If a plain object is returned from a controller or middleware,
-         * automatically set the JSON Content-Type header for the response.
-         */
-        if (result !== undefined && this.isPlainObject(result)) {
-            event.res.headers.set('Content-Type', 'application/json; charset=UTF-8')
-        }
-
-        return result
-    }
-
-    /**
-     * Sequentially runs middleware in the order they were registered.
-     * 
-     * @param context - The standardized HttpContext.
-     * @param next - Callback to execute when middleware completes.
-     * @returns A promise resolving to the final handler's result.
-     */
-    private async runMiddleware (
-        context: HttpContext,
-        next: (ctx: HttpContext) => Promise<unknown>
-    ) {
-        let index = -1
-
-        const runner = async (i: number): Promise<unknown> => {
-            if (i <= index) throw new Error('next() called multiple times')
-            index = i
-            const middleware = this.middleware[i]
-
-            if (middleware) {
-                /**
-                 * Execute the current middleware and proceed to the next one
-                 */
-                return middleware.handle(context, () => runner(i + 1))
-            } else {
-                /**
-                 * If no more middleware, call the final handler
-                 */
-                return next(context)
-            }
-        }
-
-        return runner(0)
-    }
-
-    /**
-     * Utility function to determine if a value is a plain object or array.
-     * 
-     * @param value - The value to check.
-     * @returns True if the value is a plain object or array, otherwise false.
-     */
-    private isPlainObject (value: unknown): value is Record<string, unknown> {
-        return typeof value === 'object' &&
-            value !== null &&
-            (value.constructor === Object || value.constructor === Array)
-    }
-}

package/src/Providers/AppServiceProvider.ts

@@ -1,20 +0,0 @@
-import 'reflect-metadata'
-
-import { ServiceProvider } from '../ServiceProvider'
-
-/**
- * Bootstraps core services and bindings.
- * 
- * Bind essential services to the container (logger, config repository).
- * Register app-level singletons.
- * Set up exception handling.
- * 
- * Auto-Registered
- */
-export class AppServiceProvider extends ServiceProvider {
-    public static priority = 999;
-
-    register () {
-        // Core bindings
-    }
-}

package/src/Providers/ViewServiceProvider.ts

@@ -1,21 +0,0 @@
-import { Edge } from 'edge.js'
-import { ServiceProvider } from '../ServiceProvider'
-
-export class ViewServiceProvider extends ServiceProvider {
-    public static priority = 995;
-
-    register (): void {
-        const config = this.app.make('config')
-        const edge = Edge.create({
-            cache: process.env.NODE_ENV === 'production'
-        })
-
-        edge.mount(this.app.getPath('views'))
-
-        edge.global('asset', this.app.make('asset'))
-        edge.global('config', config.get)
-        edge.global('app', this.app)
-
-        this.app.bind('edge', () => edge)
-    }
-}

package/src/ServiceProvider.ts

@@ -1,24 +0,0 @@
-import { Application } from './Application'
-import { IServiceProvider } from '@h3ravel/shared'
-
-export abstract class ServiceProvider implements IServiceProvider {
-    public static order?: `before:${string}` | `after:${string}` | string | undefined;
-    public static priority = 0;
-    protected app: Application
-
-    constructor(app: Application) {
-        this.app = app
-    }
-
-    /**
-     * Register bindings to the container.
-     * Runs before boot().
-     */
-    abstract register (): void | Promise<void>
-
-    /**
-     * Perform post-registration booting of services.
-     * Runs after all providers have been registered.
-     */
-    boot?(): void | Promise<void>
-}

package/src/index.ts

@@ -1,14 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-
-export * from './Application';
-export * from './Container';
-export * from './Controller';
-export * from './ServiceProvider';
-export * from './Contracts/ServiceProviderConstructor';
-export * from './Di/Inject';
-export * from './Exceptions/Handler';
-export * from './Http/Kernel';
-export * from './Providers/AppServiceProvider';
-export * from './Providers/ViewServiceProvider';

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../shared/tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "paths": {
-      "@h3ravel/core": ["./src/index.ts"]
-    }
-  },
-  "exclude": ["dist", "node_modules"]
-}