@valkyrjaio/valkyrja 26.0.0

package/src/Valkyrja/Http/Message/Request/Request.ts

@@ -0,0 +1,109 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { RequestContract } from './Contract/RequestContract.js';
+import type { UriContract } from '../Uri/Contract/UriContract.js';
+import type { HeaderCollectionContract } from '../Header/Collection/Contract/HeaderCollectionContract.js';
+import type { StreamContract } from '../Stream/Contract/StreamContract.js';
+import { Message } from '../Trait/Message.js';
+import { Header } from '../Header/Header.js';
+import { HeaderCollection } from '../Header/Collection/HeaderCollection.js';
+import { HeaderName } from '../Constant/HeaderName.js';
+import { RequestMethod } from '../Enum/RequestMethod.js';
+import { Stream } from '../Stream/Stream.js';
+import { Uri } from '../Uri/Uri.js';
+import { HttpRequestInvalidRequestTargetException } from './Throwable/Exception/HttpRequestInvalidRequestTargetException.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Request extends Message implements RequestContract {
+    protected requestTarget: string | null = null;
+
+    constructor(
+        protected uri: UriContract = new Uri(),
+        protected method: RequestMethod = RequestMethod.GET,
+        body: StreamContract = new Stream(),
+        protected override headers: HeaderCollectionContract = new HeaderCollection(),
+    ) {
+        super();
+        this.setBody(body);
+        this.addHostHeaderFromUri();
+    }
+
+    getRequestTarget(): string {
+        if (this.requestTarget !== null) {
+            return this.requestTarget;
+        }
+
+        let target = this.uri.getPath();
+
+        if (this.uri.getQuery()) {
+            target += '?' + this.uri.getQuery();
+        }
+
+        return target || '/';
+    }
+
+    withRequestTarget(requestTarget: string): this {
+        this.validateRequestTarget(requestTarget);
+        const clone = ObjectFactory.clone(this);
+        clone.requestTarget = requestTarget;
+        return clone;
+    }
+
+    getMethod(): RequestMethod {
+        return this.method;
+    }
+
+    withMethod(method: RequestMethod): this {
+        const clone = ObjectFactory.clone(this);
+        clone.method = method;
+        return clone;
+    }
+
+    getUri(): UriContract {
+        return this.uri;
+    }
+
+    withUri(uri: UriContract, preserveHost: boolean = false): this {
+        const clone = ObjectFactory.clone(this);
+        clone.uri = uri;
+
+        if (preserveHost && this.headers.has(HeaderName.HOST)) {
+            return clone;
+        }
+
+        if (!uri.getHost()) {
+            return clone;
+        }
+
+        const host = clone.getHostFromUri();
+        clone.headers = this.headers.withHeader(new Header(HeaderName.HOST, host));
+        return clone;
+    }
+
+    protected validateRequestTarget(requestTarget: string): void {
+        if (/\s/.test(requestTarget)) {
+            throw new HttpRequestInvalidRequestTargetException(
+                'Invalid request target provided; cannot contain whitespace',
+            );
+        }
+    }
+
+    protected getHostFromUri(): string {
+        const host = this.uri.getHost();
+        const port = this.uri.getPort();
+        return host + (port !== 0 ? `:${String(port)}` : '');
+    }
+
+    protected addHostHeaderFromUri(): void {
+        if (!this.headers.has(HeaderName.HOST) && this.uri.getHost()) {
+            this.headers = this.headers.withHeader(new Header(HeaderName.HOST, this.getHostFromUri()));
+        }
+    }
+}

package/src/Valkyrja/Http/Message/Request/ServerRequest.ts

@@ -0,0 +1,116 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from './Contract/ServerRequestContract.js';
+import type { UriContract } from '../Uri/Contract/UriContract.js';
+import type { HeaderCollectionContract } from '../Header/Collection/Contract/HeaderCollectionContract.js';
+import type { StreamContract } from '../Stream/Contract/StreamContract.js';
+import type { UploadedFileCollectionContract } from '../File/Collection/Contract/UploadedFileCollectionContract.js';
+import type { AttributeParamCollectionContract } from '../Param/Contract/AttributeParamCollectionContract.js';
+import type { CookieParamCollectionContract } from '../Param/Contract/CookieParamCollectionContract.js';
+import type { ParsedBodyParamCollectionContract } from '../Param/Contract/ParsedBodyParamCollectionContract.js';
+import type { QueryParamCollectionContract } from '../Param/Contract/QueryParamCollectionContract.js';
+import type { ServerParamCollectionContract } from '../Param/Contract/ServerParamCollectionContract.js';
+import { Request } from './Request.js';
+import { HeaderCollection } from '../Header/Collection/HeaderCollection.js';
+import { AttributeParamCollection } from '../Param/AttributeParamCollection.js';
+import { CookieParamCollection } from '../Param/CookieParamCollection.js';
+import { ParsedBodyParamCollection } from '../Param/ParsedBodyParamCollection.js';
+import { QueryParamCollection } from '../Param/QueryParamCollection.js';
+import { ServerParamCollection } from '../Param/ServerParamCollection.js';
+import { UploadedFileCollection } from '../File/Collection/UploadedFileCollection.js';
+import { HeaderName } from '../Constant/HeaderName.js';
+import { ProtocolVersion } from '../Enum/ProtocolVersion.js';
+import { RequestMethod } from '../Enum/RequestMethod.js';
+import { Stream } from '../Stream/Stream.js';
+import { Uri } from '../Uri/Uri.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class ServerRequest extends Request implements ServerRequestContract {
+    constructor(
+        uri: UriContract = new Uri(),
+        method: RequestMethod = RequestMethod.GET,
+        body: StreamContract = new Stream(),
+        headers: HeaderCollectionContract = new HeaderCollection(),
+        protocol: ProtocolVersion = ProtocolVersion.V1_1,
+        protected server: ServerParamCollectionContract = new ServerParamCollection(),
+        protected cookies: CookieParamCollectionContract = new CookieParamCollection(),
+        protected query: QueryParamCollectionContract = new QueryParamCollection(),
+        protected parsedBody: ParsedBodyParamCollectionContract = new ParsedBodyParamCollection(),
+        protected files: UploadedFileCollectionContract = new UploadedFileCollection(),
+        protected attributes: AttributeParamCollectionContract = new AttributeParamCollection(),
+    ) {
+        super(uri, method, body, headers);
+        this.protocolVersion = protocol;
+    }
+
+    getServerParams(): ServerParamCollectionContract {
+        return this.server;
+    }
+
+    withServerParams(server: ServerParamCollectionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.server = server;
+        return clone;
+    }
+
+    getCookieParams(): CookieParamCollectionContract {
+        return this.cookies;
+    }
+
+    withCookieParams(cookies: CookieParamCollectionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.cookies = cookies;
+        return clone;
+    }
+
+    getQueryParams(): QueryParamCollectionContract {
+        return this.query;
+    }
+
+    withQueryParams(query: QueryParamCollectionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.query = query;
+        return clone;
+    }
+
+    getUploadedFiles(): UploadedFileCollectionContract {
+        return this.files;
+    }
+
+    withUploadedFiles(uploadedFiles: UploadedFileCollectionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.files = uploadedFiles;
+        return clone;
+    }
+
+    getParsedBody(): ParsedBodyParamCollectionContract {
+        return this.parsedBody;
+    }
+
+    withParsedBody(params: ParsedBodyParamCollectionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.parsedBody = params;
+        return clone;
+    }
+
+    getAttributes(): AttributeParamCollectionContract {
+        return this.attributes;
+    }
+
+    withAttributes(attributes: AttributeParamCollectionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.attributes = attributes;
+        return clone;
+    }
+
+    isXmlHttpRequest(): boolean {
+        return this.headers.getHeaderLine(HeaderName.X_REQUESTED_WITH) === 'XMLHttpRequest';
+    }
+}

package/src/Valkyrja/Http/Message/Request/Throwable/Contract/HttpRequestThrowable.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { HttpMessageThrowable } from '../../../Throwable/Contract/HttpMessageThrowable.js';
+
+export type HttpRequestThrowable = HttpMessageThrowable;

package/src/Valkyrja/Http/Message/Request/Throwable/Exception/Abstract/HttpRequestInvalidArgumentException.ts

@@ -0,0 +1,15 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { HttpRequestThrowable } from '../../Contract/HttpRequestThrowable.js';
+import { HttpMessageInvalidArgumentException } from '../../../../Throwable/Exception/Abstract/HttpMessageInvalidArgumentException.js';
+
+export abstract class HttpRequestInvalidArgumentException
+    extends HttpMessageInvalidArgumentException
+    implements HttpRequestThrowable {}

package/src/Valkyrja/Http/Message/Request/Throwable/Exception/Abstract/HttpRequestRuntimeException.ts

@@ -0,0 +1,13 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { HttpRequestThrowable } from '../../Contract/HttpRequestThrowable.js';
+import { HttpMessageRuntimeException } from '../../../../Throwable/Exception/Abstract/HttpMessageRuntimeException.js';
+
+export abstract class HttpRequestRuntimeException extends HttpMessageRuntimeException implements HttpRequestThrowable {}

package/src/Valkyrja/Http/Message/Request/Throwable/Exception/HttpRequestInvalidMethodException.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { HttpRequestInvalidArgumentException } from './Abstract/HttpRequestInvalidArgumentException.js';
+
+export class HttpRequestInvalidMethodException extends HttpRequestInvalidArgumentException {}

package/src/Valkyrja/Http/Message/Request/Throwable/Exception/HttpRequestInvalidRequestTargetException.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { HttpRequestInvalidArgumentException } from './Abstract/HttpRequestInvalidArgumentException.js';
+
+export class HttpRequestInvalidRequestTargetException extends HttpRequestInvalidArgumentException {}

package/src/Valkyrja/Http/Message/Response/Contract/EmptyResponseContract.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ResponseContract } from './ResponseContract.js';
+
+export type EmptyResponseContract = ResponseContract;

package/src/Valkyrja/Http/Message/Response/Contract/HtmlResponseContract.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ResponseContract } from './ResponseContract.js';
+
+export type HtmlResponseContract = ResponseContract;

package/src/Valkyrja/Http/Message/Response/Contract/JsonResponseContract.ts

@@ -0,0 +1,24 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ResponseContract } from './ResponseContract.js';
+import type { HeaderCollectionContract } from '../../Header/Collection/Contract/HeaderCollectionContract.js';
+import type { StatusCode } from '../../Enum/StatusCode.js';
+
+export interface JsonResponseContract extends ResponseContract {
+    createFromData(
+        data?: Record<string, unknown> | null,
+        statusCode?: StatusCode | null,
+        headers?: HeaderCollectionContract | null,
+    ): this;
+    getBodyAsJson(): Record<string, unknown>;
+    withJsonAsBody(data: Record<string, unknown>): this;
+    withCallback(callback: string): this;
+    withoutCallback(): this;
+}

package/src/Valkyrja/Http/Message/Response/Contract/RedirectResponseContract.ts

@@ -0,0 +1,26 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ResponseContract } from './ResponseContract.js';
+import type { HeaderCollectionContract } from '../../Header/Collection/Contract/HeaderCollectionContract.js';
+import type { ServerRequestContract } from '../../Request/Contract/ServerRequestContract.js';
+import type { UriContract } from '../../Uri/Contract/UriContract.js';
+import type { StatusCode } from '../../Enum/StatusCode.js';
+
+export interface RedirectResponseContract extends ResponseContract {
+    createFromUri(
+        uri?: UriContract | null,
+        statusCode?: StatusCode | null,
+        headers?: HeaderCollectionContract | null,
+    ): this;
+    getUri(): UriContract;
+    withUri(uri: UriContract): this;
+    secure(path: string, request: ServerRequestContract): this;
+    back(request: ServerRequestContract): this;
+}

package/src/Valkyrja/Http/Message/Response/Contract/ResponseContract.ts

@@ -0,0 +1,23 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { MessageContract } from '../../Contract/MessageContract.js';
+import type { HeaderCollectionContract } from '../../Header/Collection/Contract/HeaderCollectionContract.js';
+import type { CookieContract } from '../../Header/Value/Contract/CookieContract.js';
+import type { StatusCode } from '../../Enum/StatusCode.js';
+
+export interface ResponseContract extends MessageContract {
+    create(content?: string | null, statusCode?: StatusCode | null, headers?: HeaderCollectionContract | null): this;
+    getStatusCode(): StatusCode;
+    withStatusCode(code: StatusCode): this;
+    getReasonPhrase(): string;
+    withReasonPhrase(reasonPhrase: string): this;
+    withCookie(cookie: CookieContract): this;
+    withoutCookie(cookie: CookieContract): this;
+}

package/src/Valkyrja/Http/Message/Response/Contract/TextResponseContract.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ResponseContract } from './ResponseContract.js';
+
+export type TextResponseContract = ResponseContract;

package/src/Valkyrja/Http/Message/Response/EmptyResponse.ts

@@ -0,0 +1,22 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { EmptyResponseContract } from './Contract/EmptyResponseContract.js';
+import type { HeaderCollectionContract } from '../Header/Collection/Contract/HeaderCollectionContract.js';
+import { Response } from './Response.js';
+import { HeaderCollection } from '../Header/Collection/HeaderCollection.js';
+import { Stream } from '../Stream/Stream.js';
+import { Mode } from '../Stream/Enum/Mode.js';
+import { StatusCode } from '../Enum/StatusCode.js';
+
+export class EmptyResponse extends Response implements EmptyResponseContract {
+    constructor(headers: HeaderCollectionContract = new HeaderCollection()) {
+        super(new Stream('', Mode.READ), StatusCode.NO_CONTENT, headers);
+    }
+}

package/src/Valkyrja/Http/Message/Response/Factory/Contract/ResponseFactoryContract.ts

@@ -0,0 +1,44 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { HeaderCollectionContract } from '../../../Header/Collection/Contract/HeaderCollectionContract.js';
+import type { JsonResponseContract } from '../../Contract/JsonResponseContract.js';
+import type { RedirectResponseContract } from '../../Contract/RedirectResponseContract.js';
+import type { ResponseContract } from '../../Contract/ResponseContract.js';
+import type { TextResponseContract } from '../../Contract/TextResponseContract.js';
+import type { StatusCode } from '../../../Enum/StatusCode.js';
+
+export interface ResponseFactoryContract {
+    createResponse(
+        content?: string | null,
+        statusCode?: StatusCode | null,
+        headers?: HeaderCollectionContract | null,
+    ): ResponseContract;
+    createTextResponse(
+        content?: string | null,
+        statusCode?: StatusCode | null,
+        headers?: HeaderCollectionContract | null,
+    ): TextResponseContract;
+    createJsonResponse(
+        data?: Record<string, unknown> | null,
+        statusCode?: StatusCode | null,
+        headers?: HeaderCollectionContract | null,
+    ): JsonResponseContract;
+    createJsonpResponse(
+        callback: string,
+        data?: Record<string, unknown> | null,
+        statusCode?: StatusCode | null,
+        headers?: HeaderCollectionContract | null,
+    ): JsonResponseContract;
+    createRedirectResponse(
+        uri?: string | null,
+        statusCode?: StatusCode | null,
+        headers?: HeaderCollectionContract | null,
+    ): RedirectResponseContract;
+}

package/src/Valkyrja/Http/Message/Response/Factory/ResponseFactory.ts

@@ -0,0 +1,64 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ResponseFactoryContract } from './Contract/ResponseFactoryContract.js';
+import type { HeaderCollectionContract } from '../../Header/Collection/Contract/HeaderCollectionContract.js';
+import type { JsonResponseContract } from '../Contract/JsonResponseContract.js';
+import type { RedirectResponseContract } from '../Contract/RedirectResponseContract.js';
+import type { ResponseContract } from '../Contract/ResponseContract.js';
+import type { TextResponseContract } from '../Contract/TextResponseContract.js';
+import { Response } from '../Response.js';
+import { TextResponse } from '../TextResponse.js';
+import { JsonResponse } from '../JsonResponse.js';
+import { RedirectResponse } from '../RedirectResponse.js';
+import { UriFactory } from '../../Uri/Factory/UriFactory.js';
+import { StatusCode } from '../../Enum/StatusCode.js';
+
+export class ResponseFactory implements ResponseFactoryContract {
+    createResponse(
+        content: string | null = null,
+        statusCode: StatusCode | null = null,
+        headers: HeaderCollectionContract | null = null,
+    ): ResponseContract {
+        return Response.create(content, statusCode, headers);
+    }
+
+    createTextResponse(
+        content: string | null = null,
+        statusCode: StatusCode | null = null,
+        headers: HeaderCollectionContract | null = null,
+    ): TextResponseContract {
+        return TextResponse.create(content, statusCode, headers);
+    }
+
+    createJsonResponse(
+        data: Record<string, unknown> | null = null,
+        statusCode: StatusCode | null = null,
+        headers: HeaderCollectionContract | null = null,
+    ): JsonResponseContract {
+        return JsonResponse.createFromData(data, statusCode, headers);
+    }
+
+    createJsonpResponse(
+        callback: string,
+        data: Record<string, unknown> | null = null,
+        statusCode: StatusCode | null = null,
+        headers: HeaderCollectionContract | null = null,
+    ): JsonResponseContract {
+        return this.createJsonResponse(data, statusCode, headers).withCallback(callback);
+    }
+
+    createRedirectResponse(
+        uri: string | null = null,
+        statusCode: StatusCode | null = null,
+        headers: HeaderCollectionContract | null = null,
+    ): RedirectResponseContract {
+        return RedirectResponse.createFromUri(UriFactory.fromString(uri ?? '/'), statusCode, headers);
+    }
+}

package/src/Valkyrja/Http/Message/Response/HtmlResponse.ts

@@ -0,0 +1,36 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { HtmlResponseContract } from './Contract/HtmlResponseContract.js';
+import type { HeaderCollectionContract } from '../Header/Collection/Contract/HeaderCollectionContract.js';
+import { Response } from './Response.js';
+import { Message } from '../Trait/Message.js';
+import { HeaderCollection } from '../Header/Collection/HeaderCollection.js';
+import { Header } from '../Header/Header.js';
+import { HeaderName } from '../Constant/HeaderName.js';
+import { ContentTypeValue } from '../Constant/ContentTypeValue.js';
+import { Stream } from '../Stream/Stream.js';
+import { StatusCode } from '../Enum/StatusCode.js';
+
+export class HtmlResponse extends Response implements HtmlResponseContract {
+    constructor(
+        html: string = '',
+        statusCode: StatusCode = StatusCode.OK,
+        headers: HeaderCollectionContract = new HeaderCollection(),
+    ) {
+        const body = new Stream();
+        body.write(html);
+        body.rewind();
+        super(
+            body,
+            statusCode,
+            Message.injectHeader(new Header(HeaderName.CONTENT_TYPE, ContentTypeValue.TEXT_HTML_UTF8), headers, true),
+        );
+    }
+}