@h3ravel/shared 0.16.0 → 0.16.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/shared",
-  "version": "0.16.0",
+  "version": "0.16.2",
   "description": "Shared Utilities.",
   "type": "module",
   "main": "./dist/index.js",
@@ -13,6 +13,10 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist",
+    "tsconfig.json"
+  ],
   "publishConfig": {
     "access": "public"
   },

package/CHANGELOG.md

@@ -1,153 +0,0 @@
-# @h3ravel/shared
-
-## 0.16.0
-
-### Minor Changes
-
-- 79f4045: feat: add add exports to package.json
-
-## 0.15.4
-
-### Patch Changes
-
-- feat: implement full IoC container resolution
-
-## 0.15.3
-
-### Patch Changes
-
-- e3b3d6c: feat: add downloads count shield.
-
-## 0.15.2
-
-### Patch Changes
-
-- feat: add homepage and repository to all packages.
-
-## 0.15.1
-
-### Patch Changes
-
-- chore: update readme accros all packages
-
-## 0.15.0
-
-### Minor Changes
-
-- d07ff49: feat: reserve the `app.` namespace for generic service provider resolution.
-
-## 0.14.0
-
-### Minor Changes
-
-- feat: add app to HttpContext interface
-
-## 0.13.0
-
-### Minor Changes
-
-- 6e249fe: feat: bind view as a self contained method to render views
-
-## 0.12.1
-
-### Patch Changes
-
-- chore: regularize all interfaces.
-
-## 0.12.0
-
-### Minor Changes
-
-- feat: add the current app instance to the Request and Response object
-
-## 0.11.0
-
-### Minor Changes
-
-- remove 'name' from RouterEnd and only join in apiResource.
-
-## 0.10.0
-
-### Minor Changes
-
-- feat: hide RouterEnd from itslelf to prevent unintentional chaining.
-
-## 0.9.0
-
-### Minor Changes
-
-- refactor!: make route definition more similar to the way it is handled in laravel.
-
-## 0.8.0
-
-### Minor Changes
-
-- feat: convert Request params and query from a method to a property and add Request headers
-
-## 0.7.1
-
-### Patch Changes
-
-- chore: add download count to readme
-
-## 0.7.0
-
-### Minor Changes
-
-- b0d1b7c: feat: flip @h3ravel/shared dependency on @h3ravel/support as it should be.
-
-## 0.6.0
-
-### Minor 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/support@0.6.0
-
-## 0.5.0
-
-### Minor Changes
-
-- rebuild all dependencies
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/support@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/support@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/support@0.3.0
-
-## 0.2.0
-
-### Minor Changes
-
-- aea734f: Fix all known bugs and improved interdependecy between packages.

package/src/Contracts/BindingsContract.ts

@@ -1,43 +0,0 @@
-// import { DotNestedKeys, DotNestedValue } from "@h3ravel/support";
-import type { H3, serve } from 'h3'
-
-import type { Edge } from 'edge.js'
-import { IRequest } from './IRequest'
-import { IResponse } from './IResponse'
-import { IRouter } from './IHttp'
-import { PathLoader } from '../Utils/PathLoader'
-
-type RemoveIndexSignature<T> = {
-    [K in keyof T as string extends K
-    ? never
-    : number extends K
-    ? never
-    : K]: T[K]
-}
-
-export type Bindings = {
-    [key: string]: any;
-    [key: `app.${string}`]: any;
-    env (): NodeJS.ProcessEnv
-    env<T extends string> (key: T, def?: any): any
-    view (templatePath: string, state?: Record<string, any>): Promise<string>
-    edge: Edge;
-    asset (key: string, def?: string): string
-    router: IRouter
-    config: {
-        // get<X extends Record<string, any>> (): X
-        // get<X extends Record<string, any>, K extends DotNestedKeys<X>> (key: K, def?: any): DotNestedValue<X, K>
-        get<X extends Record<string, any>> (): X
-        get<X extends Record<string, any>, T extends Extract<keyof X, string>> (key: T, def?: any): X[T]
-        set<T extends string> (key: T, value: any): void
-        load?(): any
-    }
-    'http.app': H3
-    'path.base': string
-    'load.paths': PathLoader
-    'http.serve': typeof serve
-    'http.request': IRequest
-    'http.response': IResponse
-}
-
-export type UseKey = keyof RemoveIndexSignature<Bindings>

package/src/Contracts/IApplication.ts

@@ -1,57 +0,0 @@
-import { IContainer } from './IContainer';
-import { IServiceProvider } from './IServiceProvider'
-
-export type IPathName = 'views' | 'routes' | 'assets' | 'base' | 'public' | 'storage' | 'config'
-
-export interface IApplication extends IContainer {
-    /**
-     * Registers configured service providers.
-     */
-    registerConfiguredProviders (): Promise<void>;
-
-    /**
-     * Registers an array of external service provider classes.
-     * @param providers - Array of service provider constructor functions.
-     */
-    registerProviders (providers: Array<new (app: IApplication) => IServiceProvider>): void;
-
-    /**
-     * Registers a single service provider.
-     * @param provider - The service provider instance to register.
-     */
-    register (provider: IServiceProvider): Promise<void>;
-
-    /**
-     * Boots all registered providers.
-     */
-    boot (): Promise<void>;
-
-    /**
-     * Gets the base path of the application.
-     * @returns The base path as a string.
-     */
-    getBasePath (): string;
-
-    /**
-     * Retrieves a path by name, optionally appending a sub-path.
-     * @param name - The name of the path property.
-     * @param pth - Optional sub-path to append.
-     * @returns The resolved path as a string.
-     */
-    getPath (name: string, pth?: string): string;
-
-    /**
-     * Sets a path for a given name.
-     * @param name - The name of the path property.
-     * @param path - The path to set.
-     * @returns
-     */
-    setPath (name: IPathName, path: string): void;
-
-    /**
-     * Gets the version of the application or TypeScript.
-     * @param key - The key to retrieve ('app' or 'ts').
-     * @returns The version string or undefined.
-     */
-    getVersion (key: 'app' | 'ts'): string | undefined;
-}

package/src/Contracts/IContainer.ts

@@ -1,40 +0,0 @@
-import type { Bindings, UseKey } from './BindingsContract';
-
-/**
- * Interface for the Container contract, defining methods for dependency injection and service resolution.
- */
-export interface IContainer {
-    /**
-     * Binds a transient service to the container.
-     * @param key - The key or constructor for the service.
-     * @param factory - The factory function to create the service instance.
-     */
-    bind<T> (key: new (...args: any[]) => T, factory: () => T): void;
-    bind<T extends UseKey> (key: T, factory: () => Bindings[T]): void;
-
-    /**
-     * Binds a singleton service to the container.
-     * @param key - The key or constructor for the service.
-     * @param factory - The factory function to create the singleton instance.
-     */
-    singleton<T extends UseKey> (
-        key: T | (new (...args: any[]) => Bindings[T]),
-        factory: () => Bindings[T]
-    ): void;
-
-    /**
-     * Resolves a service from the container.
-     * @param key - The key or constructor for the service.
-     * @returns The resolved service instance.
-     */
-    make<T extends UseKey, X = undefined> (
-        key: T | (new (..._args: any[]) => Bindings[T])
-    ): X extends undefined ? Bindings[T] : X
-
-    /**
-     * Checks if a service is registered in the container.
-     * @param key - The key to check.
-     * @returns True if the service is registered, false otherwise.
-     */
-    has (key: UseKey): boolean;
-}

package/src/Contracts/IHttp.ts

@@ -1,142 +0,0 @@
-import type { Middleware, MiddlewareOptions } from 'h3'
-
-import { IApplication } from './IApplication'
-import { IRequest } from './IRequest'
-import { IResponse } from './IResponse'
-
-export type RouterEnd = 'get' | 'delete' | 'put' | 'post' | 'apiResource' | 'group' | 'route';
-
-/**
- * Interface for the Router contract, defining methods for HTTP routing.
- */
-export interface IRouter {
-    /**
-     * Registers a GET route.
-     * @param path - The route path.
-     * @param definition - The handler function or [controller class, method] array.
-     * @param name - Optional route name.
-     * @param middleware - Optional middleware array.
-     */
-    get (
-        path: string,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware?: IMiddleware[]
-    ): Omit<this, RouterEnd>;
-
-    /**
-     * Registers a POST route.
-     * @param path - The route path.
-     * @param definition - The handler function or [controller class, method] array.
-     * @param name - Optional route name.
-     * @param middleware - Optional middleware array.
-     */
-    post (
-        path: string,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware?: IMiddleware[]
-    ): Omit<this, RouterEnd>;
-
-    /**
-     * Registers a PUT route.
-     * @param path - The route path.
-     * @param definition - The handler function or [controller class, method] array.
-     * @param name - Optional route name.
-     * @param middleware - Optional middleware array.
-     */
-    put (
-        path: string,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware?: IMiddleware[]
-    ): Omit<this, RouterEnd>;
-
-    /**
-     * Registers a DELETE route.
-     * @param path - The route path.
-     * @param definition - The handler function or [controller class, method] array.
-     * @param name - Optional route name.
-     * @param middleware - Optional middleware array.
-     */
-    delete (
-        path: string,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware?: IMiddleware[]
-    ): Omit<this, RouterEnd>;
-
-    /**
-     * Registers an API resource with standard CRUD routes.
-     * @param path - The base path for the resource.
-     * @param controller - The controller class handling the resource.
-     * @param middleware - Optional middleware array.
-     */
-    apiResource (
-        path: string,
-        controller: new (app: IApplication) => IController,
-        middleware?: IMiddleware[]
-    ): Omit<this, RouterEnd | 'name'>;
-
-    /**
-     * Generates a URL for a named route.
-     * @param name - The name of the route.
-     * @param params - Optional parameters to replace in the route path.
-     * @returns The generated URL or undefined if the route is not found.
-     */
-    route (name: string, params?: Record<string, string>): string | undefined;
-
-
-    /**
-     * Set the name of the current route
-     * 
-     * @param name 
-     */
-    name (name: string): this
-
-    /**
-     * Groups routes with shared prefix or middleware.
-     * @param options - Configuration for prefix or middleware.
-     * @param callback - Callback function defining grouped routes.
-     */
-    group (options: { prefix?: string; middleware?: EventHandler[] }, callback: () => void): this;
-
-    /**
-     * Registers middleware for a specific path.
-     * @param path - The path to apply the middleware.
-     * @param handler - The middleware handler.
-     * @param opts - Optional middleware options.
-     */
-    middleware (path: string | IMiddleware[], handler: Middleware, opts?: MiddlewareOptions): this;
-}
-
-export interface HttpContext {
-    app: IApplication
-    request: IRequest
-    response: IResponse
-}
-
-/**
- * Type for EventHandler, representing a function that handles an H3 event.
- */
-export type EventHandler = (ctx: HttpContext) => any
-
-/**
- * Defines the contract for all controllers.
- * Any controller implementing this must define these methods.
- */
-export interface IController {
-    show (ctx: HttpContext): any
-    index (ctx: HttpContext): any
-    store (ctx: HttpContext): any
-    update (ctx: HttpContext): any
-    destroy (ctx: HttpContext): any
-}
-
-/**
- * Defines the contract for all middlewares.
- * Any middleware implementing this must define these methods.
- */
-export interface IMiddleware {
-    handle (context: HttpContext, next: () => Promise<any>): Promise<any>
-} 

package/src/Contracts/IRequest.ts

@@ -1,55 +0,0 @@
-import { DotNestedKeys, DotNestedValue } from './ObjContract'
-import type { ResponseHeaderMap, TypedHeaders } from 'fetchdts'
-
-import type { H3Event } from 'h3'
-import type { IApplication } from './IApplication';
-
-/**
- * Interface for the Request contract, defining methods for handling HTTP request data.
- */
-export interface IRequest {
-    /**
-     * The current app instance
-     */
-    app: IApplication
-
-    /**
-     * Gets route parameters.
-     * @returns An object containing route parameters.
-     */
-    params: NonNullable<H3Event["context"]["params"]>;
-
-    /**
-     * Gets query parameters.
-     * @returns An object containing query parameters.
-     */
-    query: Record<string, any>;
-
-    /**
-     * Gets the request headers.
-     * @returns An object containing request headers.
-     */
-    headers: TypedHeaders<Record<keyof ResponseHeaderMap, string>>;
-
-    /**
-     * Gets all input data (query parameters, route parameters, and body).
-     * @returns A promise resolving to an object containing all input data.
-     */
-    all<T = Record<string, unknown>> (): Promise<T>;
-
-    /**
-     * Gets a single input field from query or body.
-     * @param key - The key of the input field.
-     * @param defaultValue - Optional default value if the key is not found.
-     * @returns A promise resolving to the value of the input field or the default value.
-     */
-    input<T = unknown> (key: string, defaultValue?: T): Promise<T>;
-
-    /**
-     * Gets the underlying event object or a specific property of it.
-     * @param key - Optional key to access a nested property of the event.
-     * @returns The entire event object or the value of the specified property.
-     */
-    getEvent (): H3Event;
-    getEvent<K extends DotNestedKeys<H3Event>> (key: K): DotNestedValue<H3Event, K>;
-}

package/src/Contracts/IResponse.ts

@@ -1,66 +0,0 @@
-import { DotNestedKeys, DotNestedValue } from './ObjContract'
-
-import type { H3Event } from 'h3'
-import type { IApplication } from './IApplication';
-
-/**
- * Interface for the Response contract, defining methods for handling HTTP responses.
- */
-export interface IResponse {
-    /**
-     * The current app instance
-     */
-    app: IApplication
-
-    /**
-     * Sets the HTTP status code for the response.
-     * @param code - The HTTP status code.
-     * @returns The instance for method chaining.
-     */
-    setStatusCode (code: number): this;
-
-    /**
-     * Sets a response header.
-     * @param name - The header name.
-     * @param value - The header value.
-     * @returns The instance for method chaining.
-     */
-    setHeader (name: string, value: string): this;
-
-    /**
-     * Sends an HTML response.
-     * @param content - The HTML content to send.
-     * @returns The HTML content.
-     */
-    html (content: string): string;
-
-    /**
-     * Sends a JSON response.
-     * @param data - The data to send as JSON.
-     * @returns The input data.
-     */
-    json<T = unknown> (data: T): T;
-
-    /**
-     * Sends a plain text response.
-     * @param data - The text content to send.
-     * @returns The text content.
-     */
-    text (data: string): string;
-
-    /**
-     * Redirects to another URL.
-     * @param url - The URL to redirect to.
-     * @param status - The HTTP status code for the redirect (default: 302).
-     * @returns The redirect URL.
-     */
-    redirect (url: string, status?: number): string;
-
-    /**
-     * Gets the underlying event object or a specific property of it.
-     * @param key - Optional key to access a nested property of the event.
-     * @returns The entire event object or the value of the specified property.
-     */
-    getEvent (): H3Event;
-    getEvent<K extends DotNestedKeys<H3Event>> (key: K): DotNestedValue<H3Event, K>;
-}

package/src/Contracts/IServiceProvider.ts

@@ -1,23 +0,0 @@
-export interface IServiceProvider {
-    /**
-     * Sort order
-     */
-    order?: `before:${string}` | `after:${string}` | string | undefined
-
-    /**
-     * Sort priority
-     */
-    priority?: number;
-
-    /**
-     * Register bindings to the container.
-     * Runs before boot().
-     */
-    register (): void | Promise<void>
-
-    /**
-     * Perform post-registration booting of services.
-     * Runs after all providers have been registered.
-     */
-    boot?(): void | Promise<void>
-} 

package/src/Contracts/ObjContract.ts

@@ -1,44 +0,0 @@
-/**
- * Adds a dot prefix to nested keys
- */
-type DotPrefix<T extends string, U extends string> =
-    T extends '' ? U : `${T}.${U}`
-
-/**
- * Converts a union of objects into a single merged object
- */
-type MergeUnion<T> =
-    (T extends any ? (k: T) => void : never) extends
-    (k: infer I) => void ? { [K in keyof I]: I[K] } : never
-
-/**
- * Flattens nested objects into dotted keys
- */
-export type DotFlatten<T, Prefix extends string = ''> = MergeUnion<{
-    [K in keyof T & string]:
-    T[K] extends Record<string, any>
-    ? DotFlatten<T[K], DotPrefix<Prefix, K>>
-    : { [P in DotPrefix<Prefix, K>]: T[K] }
-}[keyof T & string]>
-
-/**
- * Builds "nested.key" paths for autocompletion
- */
-export type DotNestedKeys<T> = {
-    [K in keyof T & string]:
-    T[K] extends object
-    ? `${K}` | `${K}.${DotNestedKeys<T[K]>}`
-    : `${K}`
-}[keyof T & string]
-
-/**
- * Retrieves type at a given dot-path
- */
-export type DotNestedValue<T, Path extends string> =
-    Path extends `${infer Key}.${infer Rest}`
-    ? Key extends keyof T
-    ? DotNestedValue<T[Key], Rest>
-    : never
-    : Path extends keyof T
-    ? T[Path]
-    : never 

package/src/Utils/PathLoader.ts

@@ -1,48 +0,0 @@
-import { IPathName } from '../Contracts/IApplication'
-import nodepath from 'path'
-
-export class PathLoader {
-    private paths = {
-        base: '',
-        views: '/src/resources/views',
-        assets: '/public/assets',
-        routes: '/src/routes',
-        config: '/src/config',
-        public: '/public',
-        storage: '/storage',
-    }
-
-    /**
-     * 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
-     * @param base - The base path to include to the path
-     * @returns 
-     */
-    getPath (name: IPathName, base?: string): string {
-        let path: string;
-
-        if (base && name !== 'base') {
-            path = nodepath.join(base, this.paths[name])
-        } else {
-            path = this.paths[name]
-        }
-        return path.replace('/src/', `/${process.env.SRC_PATH ?? 'src'}/`.replace(/([^:]\/)\/+/g, "$1"))
-    }
-
-    /**
-     * Programatically set the paths.
-     *
-     * @param name - The base name of the path property
-     * @param path - The new path
-     * @param base - The base path to include to the path
-     */
-    setPath (name: IPathName, path: string, base?: string) {
-        if (base && name !== 'base') {
-            this.paths[name] = nodepath.join(base, path)
-        }
-
-        this.paths[name] = path
-    }
-}

package/src/index.ts

@@ -1,13 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-
-export * from './Contracts/BindingsContract';
-export * from './Contracts/IApplication';
-export * from './Contracts/IContainer';
-export * from './Contracts/IHttp';
-export * from './Contracts/IRequest';
-export * from './Contracts/IResponse';
-export * from './Contracts/IServiceProvider';
-export * from './Contracts/ObjContract';
-export * from './Utils/PathLoader';