@h3ravel/http 8.0.2 → 8.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/http",
-  "version": "8.0.2",
+  "version": "8.0.3",
   "description": "HTTP kernel, middleware pipeline, request/response classes for H3ravel.",
   "type": "module",
   "main": "./dist/index.js",
@@ -13,6 +13,9 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -35,11 +38,11 @@
   "dependencies": {
     "h3": "^2.0.0-beta.1",
     "srvx": "^0.8.2",
-    "@h3ravel/support": "^0.8.0",
-    "@h3ravel/shared": "^0.16.0"
+    "@h3ravel/support": "^0.8.1",
+    "@h3ravel/shared": "^0.16.1"
   },
   "peerDependencies": {
-    "@h3ravel/core": "^1.4.0"
+    "@h3ravel/core": "^1.4.1"
   },
   "devDependencies": {
     "typescript": "^5.4.0"

package/CHANGELOG.md

@@ -1,257 +0,0 @@
-# @h3ravel/http
-
-## 8.0.2
-
-### Patch Changes
-
-- fix: nothing at all
-
-## 8.0.0
-
-### Minor Changes
-
-- 79f4045: feat: add add exports to package.json
-
-### Patch Changes
-
-- Updated dependencies [79f4045]
-  - @h3ravel/support@0.8.0
-  - @h3ravel/shared@0.16.0
-  - @h3ravel/core@1.4.0
-
-## 7.0.0
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/core@1.3.0
-  - @h3ravel/shared@0.15.4
-
-## 6.0.2
-
-### Patch Changes
-
-- feat: add homepage and repository to all packages.
-- Updated dependencies
-  - @h3ravel/core@1.2.2
-  - @h3ravel/shared@0.15.2
-  - @h3ravel/support@0.7.5
-
-## 6.0.1
-
-### Patch Changes
-
-- chore: update readme accros all packages
-- Updated dependencies
-  - @h3ravel/core@1.2.1
-  - @h3ravel/shared@0.15.1
-  - @h3ravel/support@0.7.4
-
-## 6.0.0
-
-### Patch Changes
-
-- Updated dependencies [d07ff49]
-  - @h3ravel/shared@0.15.0
-  - @h3ravel/core@1.2.0
-  - @h3ravel/support@0.7.3
-
-## 5.0.5
-
-### Patch Changes
-
-- db0dd70: chore: revert to old workspace core dependency
-
-## 5.0.4
-
-### Patch Changes
-
-- chore: remove core as a queue dependency, leave as peer
-
-## 5.0.3
-
-### Patch Changes
-
-- version: explicitly set the latest version as pearDependency in requiring packages.
-
-## 5.0.2
-
-### Patch Changes
-
-- chore: require the latest dependencies from the framework
-- Updated dependencies
-  - @h3ravel/support@0.7.3
-  - @h3ravel/core@1.1.2
-
-## 5.0.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.14.0
-  - @h3ravel/core@1.1.1
-  - @h3ravel/support@0.7.2
-
-## 5.0.0
-
-### Patch Changes
-
-- Updated dependencies [6e249fe]
-  - @h3ravel/shared@0.13.0
-  - @h3ravel/core@1.1.0
-  - @h3ravel/support@0.7.2
-
-## 4.2.2
-
-### Patch Changes
-
-- chore: regularize all interfaces.
-- Updated dependencies
-  - @h3ravel/core@1.0.9
-  - @h3ravel/shared@0.12.1
-  - @h3ravel/support@0.7.2
-
-## 4.2.1
-
-### Patch Changes
-
-- fix: use the Application class directly as the app property of the Request and Response classes.
-
-## 4.2.0
-
-### Minor Changes
-
-- feat: add the current app instance to the Request and Response object
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.12.0
-  - @h3ravel/core@1.0.8
-  - @h3ravel/support@0.7.1
-
-## 4.1.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.11.0
-  - @h3ravel/core@1.0.7
-  - @h3ravel/support@0.7.1
-
-## 4.1.2
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.10.0
-  - @h3ravel/core@1.0.6
-  - @h3ravel/support@0.7.1
-
-## 4.1.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.9.0
-  - @h3ravel/core@1.0.5
-  - @h3ravel/support@0.7.1
-
-## 4.1.0
-
-### Minor Changes
-
-- feat: convert Request params and query from a method to a property and add Request headers
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.8.0
-  - @h3ravel/core@1.0.4
-  - @h3ravel/support@0.7.1
-
-## 4.0.3
-
-### Patch Changes
-
-- chore: add download count to readme
-- Updated dependencies
-  - @h3ravel/core@1.0.3
-  - @h3ravel/shared@0.7.1
-  - @h3ravel/support@0.7.1
-
-## 4.0.2
-
-### Patch Changes
-
-- Updated dependencies [b0d1b7c]
-- Updated dependencies [ce51a92]
-  - @h3ravel/support@0.7.0
-  - @h3ravel/shared@0.7.0
-  - @h3ravel/core@1.0.2
-
-## 4.0.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/core@1.0.0
-  - @h3ravel/shared@0.6.0
-  - @h3ravel/support@0.6.0
-
-## 3.0.0
-
-### Minor Changes
-
-- rebuild all dependencies
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/core@0.5.0
-  - @h3ravel/shared@0.5.0
-  - @h3ravel/support@0.5.0
-
-## 2.0.0
-
-### 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/core@0.4.0
-  - @h3ravel/shared@0.4.0
-  - @h3ravel/support@0.4.0
-
-## 1.0.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/core@0.3.0
-  - @h3ravel/shared@0.3.0
-  - @h3ravel/support@0.3.0
-
-## 0.2.0
-
-### Minor Changes
-
-- aea734f: Fix all known bugs and improved interdependecy between packages.
-
-### Patch Changes
-
-- Updated dependencies [aea734f]
-  - @h3ravel/core@0.2.0
-  - @h3ravel/support@0.2.0

package/src/Contracts/HttpContract.ts

@@ -1,3 +0,0 @@
-import { HttpContext as IHttpContext } from '@h3ravel/shared'
-
-export type HttpContext = IHttpContext

package/src/Middleware/LogRequests.ts

@@ -1,10 +0,0 @@
-import { HttpContext } from '@h3ravel/shared'
-import { Middleware } from '../Middleware'
-
-export class LogRequests extends Middleware {
-    async handle ({ request }: HttpContext, next: () => Promise<unknown>): Promise<unknown> {
-        const url = request.getEvent('url')
-        console.log(`[${request.getEvent('method')}] ${url.pathname + url.search}`)
-        return next()
-    }
-}

package/src/Middleware.ts

@@ -1,6 +0,0 @@
-import { HttpContext } from './Contracts/HttpContract'
-import { IMiddleware } from '@h3ravel/shared'
-
-export abstract class Middleware implements IMiddleware {
-    abstract handle (context: HttpContext, next: () => Promise<unknown>): Promise<unknown>
-}

package/src/Providers/HttpServiceProvider.ts

@@ -1,24 +0,0 @@
-import { H3, serve } from 'h3'
-
-import { ServiceProvider } from '@h3ravel/core'
-
-/**
- * Sets up HTTP kernel and request lifecycle.
- * 
- * Register Request, Response, and Middleware classes.
- * Configure global middleware stack.
- * Boot HTTP kernel.
- * 
- * Auto-Registered
- */
-export class HttpServiceProvider extends ServiceProvider {
-    public static priority = 998;
-
-    register () {
-        this.app.singleton('http.app', () => {
-            return new H3()
-        })
-
-        this.app.singleton('http.serve', () => serve)
-    }
-}

package/src/Request.ts

@@ -1,78 +0,0 @@
-import { getQuery, getRouterParams, readBody, type H3Event } from 'h3'
-import { DotNestedKeys, DotNestedValue, safeDot } from '@h3ravel/support'
-import type { ResponseHeaderMap, TypedHeaders } from 'fetchdts'
-import { IRequest } from '@h3ravel/shared'
-import { Application } from '@h3ravel/core'
-
-export class Request implements IRequest {
-    /**
-     * Gets route parameters.
-     * @returns An object containing route parameters.
-     */
-    readonly params: NonNullable<H3Event["context"]["params"]>
-
-    /**
-     * Gets query parameters.
-     * @returns An object containing query parameters.
-     */
-    readonly query: Record<string, string>;
-
-    /**
-     * Gets the request headers.
-     * @returns An object containing request headers.
-     */
-    readonly headers: TypedHeaders<Record<keyof ResponseHeaderMap, string>>
-
-    /**
-     * The current H3 H3Event instance
-     */
-    private readonly event: H3Event
-
-    constructor(
-        event: H3Event,
-        /**
-         * The current app instance
-         */
-        public app: Application
-    ) {
-        this.event = event
-        this.query = getQuery(this.event)
-        this.params = getRouterParams(this.event)
-        this.headers = this.event.req.headers
-    }
-
-    /**
-     * Get all input data (query + body).
-     */
-    async all<T = Record<string, unknown>> (): Promise<T> {
-        let data = {
-            ...getRouterParams(this.event),
-            ...getQuery(this.event),
-        } as T
-
-        if (this.event.req.method === 'POST') {
-            data = Object.assign({}, data, Object.fromEntries((await this.event.req.formData()).entries()))
-        } else if (this.event.req.method === 'PUT') {
-            data = <never>Object.fromEntries(Object.entries(<never>await readBody(this.event)))
-        }
-
-        return data
-    }
-
-    /**
-     * Get a single input field from query or body.
-     */
-    async input<T = unknown> (key: string, defaultValue?: T): Promise<T> {
-        const data = await this.all<Record<string, T>>()
-        return (data[key] ?? defaultValue) as T
-    }
-
-    /**
-     * Get the base event
-     */
-    getEvent (): H3Event
-    getEvent<K extends DotNestedKeys<H3Event>> (key: K): DotNestedValue<H3Event, K>
-    getEvent<K extends DotNestedKeys<H3Event>> (key?: K): any {
-        return safeDot(this.event, key)
-    }
-}

package/src/Resources/ApiResource.ts

@@ -1,39 +0,0 @@
-import { JsonResource, Resource } from './JsonResource'
-
-import { H3Event } from 'h3'
-
-export function ApiResource (
-    instance: JsonResource
-) {
-    return new Proxy(instance, {
-        get (target, prop, receiver) {
-            const value = Reflect.get(target, prop, receiver)
-            if (typeof value === 'function') {
-                // Intercept json, additional, and send methods
-                if (prop === 'json' || prop === 'additional') {
-                    return (...args: any[]) => {
-                        const result = value.apply(target, args)
-                        // Schedule checkSend after json or additional
-                        setImmediate(() => target['checkSend']())
-                        return result
-                    }
-                } else if (prop === 'send') {
-                    return (...args: any[]) => {
-                        // Prevent checkSend from firing
-                        target['shouldSend'] = false
-
-                        return value.apply(target, args)
-                    }
-                }
-            }
-            return value
-        },
-    })
-}
-
-export default function BaseResource<R extends Resource> (
-    evt: H3Event,
-    rsc: R
-) {
-    return ApiResource(new JsonResource<R>(evt, rsc))
-}

package/src/Resources/JsonResource.ts

@@ -1,201 +0,0 @@
-import { EventHandlerRequest, H3Event } from 'h3'
-
-export interface Resource {
-    [key: string]: any;
-    pagination?: {
-        from?: number | undefined;
-        to?: number | undefined;
-        perPage?: number | undefined;
-        total?: number | undefined;
-    } | undefined;
-}
-
-type BodyResource = Resource & {
-    data: Omit<Resource, 'pagination'>,
-    meta?: {
-        pagination?: Resource['pagination']
-    } | undefined;
-}
-
-/**
- * Class to render API resource
- */
-export class JsonResource<R extends Resource = any> {
-    /**
-     * The request instance
-     */
-    request: H3Event<EventHandlerRequest>['req']
-    /**
-     * The response instance
-     */
-    response: H3Event['res']
-    /**
-     * The data to send to the client
-     */
-    resource: R
-    /**
-     * The final response data object
-     */
-    body: BodyResource = {
-        data: {},
-    }
-    /**
-     * Flag to track if response should be sent automatically
-     */
-    private shouldSend: boolean = false
-    /**
-     * Flag to track if response has been sent
-     */
-
-    private responseSent: boolean = false;
-
-    /**
-     * Declare that this includes R's properties
-     */
-    [key: string]: any;
-
-    /**
-     * @param req The request instance
-     * @param res The response instance
-     * @param rsc The data to send to the client
-     */
-    constructor(protected event: H3Event, rsc: R) {
-        this.request = event.req
-        this.response = event.res
-        this.resource = rsc
-
-        // Copy all properties from rsc to this, avoiding conflicts
-        for (const key of Object.keys(rsc)) {
-            if (!(key in this)) {
-                Object.defineProperty(this, key, {
-                    enumerable: true,
-                    configurable: true,
-                    get: () => this.resource[key],
-                    set: (value) => {
-                        (<any>this.resource)[key] = value
-                    },
-                })
-            }
-        }
-    }
-
-    /**
-     * Return the data in the expected format
-     * 
-     * @returns 
-     */
-    data (): Resource {
-        return this.resource
-    }
-
-    /**
-     * Build the response object
-     * @returns this
-     */
-    json () {
-        // Indicate response should be sent automatically
-        this.shouldSend = true
-
-        // Set default status code
-        this.response.status = 200
-
-        // Prepare body
-        const resource = this.data()
-        let data: Resource = Array.isArray(resource) ? [...resource] : { ...resource }
-
-        if (typeof data.data !== 'undefined') {
-            data = data.data
-        }
-
-        if (!Array.isArray(resource)) {
-            delete data.pagination
-        }
-
-        this.body = {
-            data,
-        }
-
-        // Set the pagination from the data() resource, if available
-        if (!Array.isArray(resource) && resource.pagination) {
-            const meta: BodyResource['meta'] = this.body.meta ?? {}
-            meta.pagination = resource.pagination
-            this.body.meta = meta
-        }
-
-        // If pagination is not available on the resource, then check and set it
-        // if it's available on the base resource.
-        if (this.resource.pagination && !this.body.meta?.pagination) {
-            const meta: BodyResource['meta'] = this.body.meta ?? {}
-            meta.pagination = this.resource.pagination
-            this.body.meta = meta
-        }
-
-        return this
-    }
-
-    /**
-     * Add context data to the response object
-     * @param data Context data
-     * @returns this
-     */
-    additional<X extends { [key: string]: any }> (data: X) {
-
-        // Allow automatic send after additional
-        this.shouldSend = true
-
-        // Merge data with body
-        delete data.data
-        delete data.pagination
-
-        this.body = {
-            ...this.body,
-            ...data,
-        }
-
-        return this
-    }
-
-    /**
-     * Send the output to the client
-     * @returns this
-     */
-    send () {
-        this.shouldSend = false // Prevent automatic send
-        if (!this.responseSent) {
-            this.#send()
-        }
-        return this
-    }
-
-    /**
-     * Set the status code for this response
-     * @param code Status code
-     * @returns this
-     */
-    status (code: number) {
-        this.response.status = code
-        return this
-    }
-
-    /**
-     * Private method to send the response
-     */
-    #send () {
-        if (!this.responseSent) {
-            this.event.context.
-                this.response.json(this.body)
-
-            // Mark response as sent
-            this.responseSent = true
-        }
-    }
-
-    /**
-     * Check if send should be triggered automatically
-     */
-    private checkSend () {
-        if (this.shouldSend && !this.responseSent) {
-            this.#send()
-        }
-    }
-}

package/src/Response.ts

@@ -1,92 +0,0 @@
-import { DotNestedKeys, DotNestedValue, safeDot } from '@h3ravel/support'
-import { html, redirect, } from 'h3'
-
-import { Application } from '@h3ravel/core'
-import type { H3Event } from 'h3'
-import { IResponse } from '@h3ravel/shared'
-
-export class Response implements IResponse {
-    /**
-     * The current H3 H3Event instance
-     */
-    private readonly event: H3Event
-
-    private statusCode: number = 200
-    private headers: Record<string, string> = {}
-
-    constructor(
-        event: H3Event,
-        /**
-         * The current app instance
-         */
-        public app: Application
-    ) {
-        this.event = event
-    }
-
-    /**
-     * Set HTTP status code.
-     */
-    setStatusCode (code: number): this {
-        this.statusCode = code
-        this.event.res.status = code
-        return this
-    }
-
-    /**
-     * Set a header.
-     */
-    setHeader (name: string, value: string): this {
-        this.headers[name] = value
-        return this
-    }
-
-    html (content: string): string {
-        this.applyHeaders()
-        return html(this.event, content)
-    }
-
-    /**
-     * Send a JSON response.
-     */
-    json<T = unknown> (data: T): T {
-        this.setHeader('content-type', 'application/json; charset=utf-8')
-        this.applyHeaders()
-        return data
-    }
-
-    /**
-     * Send plain text.
-     */
-    text (data: string): string {
-        this.setHeader('content-type', 'text/plain; charset=utf-8')
-        this.applyHeaders()
-        return data
-    }
-
-    /**
-     * Redirect to another URL.
-     */
-    redirect (url: string, status = 302): string {
-        this.setStatusCode(status)
-        return redirect(this.event, url, this.statusCode)
-    }
-
-    /**
-     * Apply headers before sending response.
-     */
-    private applyHeaders (): void {
-        Object.entries(this.headers).forEach(([key, value]) => {
-            this.event.res.headers.set(key, value)
-        })
-    }
-
-    /**
-     * Get the base event
-     */
-    getEvent (): H3Event
-    getEvent<K extends DotNestedKeys<H3Event>> (key: K): DotNestedValue<H3Event, K>
-    getEvent<K extends DotNestedKeys<H3Event>> (key?: K): any {
-        return safeDot(this.event, key)
-    }
-}

package/src/index.ts

@@ -1,12 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-
-export * from './Middleware';
-export * from './Request';
-export * from './Response';
-export * from './Contracts/HttpContract';
-export * from './Middleware/LogRequests';
-export * from './Providers/HttpServiceProvider';
-export * from './Resources/ApiResource';
-export * from './Resources/JsonResource';

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../shared/tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src"],
-  "exclude": ["dist", "node_modules"]
-}