@valkyrjaio/valkyrja 26.0.0

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

@@ -0,0 +1,140 @@
+/*
+ * 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 { StreamContract } from './Contract/StreamContract.js';
+import { Mode, modeIsReadable, modeIsWritable } from './Enum/Mode.js';
+import { StreamFactory } from './Factory/StreamFactory.js';
+import { HttpStreamInvalidLengthException } from './Throwable/Exception/HttpStreamInvalidLengthException.js';
+
+export class Stream implements StreamContract {
+    protected buffer: Buffer;
+    protected position: number = 0;
+    protected closed: boolean = false;
+
+    constructor(
+        protected content: string = '',
+        protected mode: Mode = Mode.WRITE_READ,
+    ) {
+        this.buffer = Buffer.from(content, 'utf8');
+        if (modeIsWritable(this.mode) && !modeIsReadable(this.mode)) {
+            this.position = this.buffer.length;
+        }
+    }
+
+    toString(): string {
+        return StreamFactory.toString(this);
+    }
+
+    close(): void {
+        this.closed = true;
+        this.buffer = Buffer.alloc(0);
+        this.position = 0;
+    }
+
+    detach(): Buffer | null {
+        if (this.closed) {
+            return null;
+        }
+        const buf = this.buffer;
+        this.closed = true;
+        this.buffer = Buffer.alloc(0);
+        this.position = 0;
+        return buf;
+    }
+
+    getSize(): number {
+        return this.buffer.length;
+    }
+
+    tell(): number {
+        if (this.closed) {
+            StreamFactory.verifyTellResult(false);
+        }
+        return this.position;
+    }
+
+    eof(): boolean {
+        return this.closed || this.position >= this.buffer.length;
+    }
+
+    isSeekable(): boolean {
+        return !this.closed;
+    }
+
+    seek(offset: number, whence: number = 0): void {
+        StreamFactory.verifySeekable(this);
+        let newPos: number;
+        if (whence === 0) {
+            newPos = offset;
+        } else if (whence === 1) {
+            newPos = this.position + offset;
+        } else {
+            newPos = this.buffer.length + offset;
+        }
+        if (newPos < 0 || newPos > this.buffer.length) {
+            StreamFactory.verifySeekResult(-1);
+        }
+        this.position = newPos;
+    }
+
+    rewind(): void {
+        this.seek(0);
+    }
+
+    isWritable(): boolean {
+        return !this.closed && modeIsWritable(this.mode);
+    }
+
+    write(string: string): number {
+        StreamFactory.verifyWritable(this);
+        const chunk = Buffer.from(string, 'utf8');
+        const before = this.buffer.subarray(0, this.position);
+        const after = this.buffer.subarray(this.position + chunk.length);
+        this.buffer = Buffer.concat([before, chunk, after]);
+        this.position += chunk.length;
+        return chunk.length;
+    }
+
+    isReadable(): boolean {
+        return !this.closed && modeIsReadable(this.mode);
+    }
+
+    read(length: number): string {
+        if (length < 0) {
+            throw new HttpStreamInvalidLengthException(
+                `Invalid length of ${String(length)} provided. Length must be greater than 0`,
+            );
+        }
+        StreamFactory.verifyReadable(this);
+        const chunk = this.buffer.subarray(this.position, this.position + length);
+        this.position += chunk.length;
+        return chunk.toString('utf8');
+    }
+
+    getContents(): string {
+        StreamFactory.verifyReadable(this);
+        const chunk = this.buffer.subarray(this.position);
+        this.position = this.buffer.length;
+        return chunk.toString('utf8');
+    }
+
+    getMetadata(): Record<string, unknown> {
+        if (this.closed) {
+            return {};
+        }
+        return {
+            seekable: this.isSeekable(),
+            mode: this.mode,
+        };
+    }
+
+    getMetadataItem(key: string): unknown {
+        return this.getMetadata()[key] ?? null;
+    }
+}

package/src/Valkyrja/Http/Message/Stream/Throwable/Contract/HttpStreamThrowable.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 HttpStreamThrowable = HttpMessageThrowable;

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/Abstract/HttpStreamInvalidArgumentException.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 { HttpStreamThrowable } from '../../Contract/HttpStreamThrowable.js';
+import { HttpMessageInvalidArgumentException } from '../../../../Throwable/Exception/Abstract/HttpMessageInvalidArgumentException.js';
+
+export abstract class HttpStreamInvalidArgumentException
+    extends HttpMessageInvalidArgumentException
+    implements HttpStreamThrowable {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/Abstract/HttpStreamRuntimeException.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 { HttpStreamThrowable } from '../../Contract/HttpStreamThrowable.js';
+import { HttpMessageRuntimeException } from '../../../../Throwable/Exception/Abstract/HttpMessageRuntimeException.js';
+
+export abstract class HttpStreamRuntimeException extends HttpMessageRuntimeException implements HttpStreamThrowable {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamInvalidLengthException.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 { HttpStreamInvalidArgumentException } from './Abstract/HttpStreamInvalidArgumentException.js';
+
+export class HttpStreamInvalidLengthException extends HttpStreamInvalidArgumentException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamInvalidStreamException.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 { HttpStreamInvalidArgumentException } from './Abstract/HttpStreamInvalidArgumentException.js';
+
+export class HttpStreamInvalidStreamException extends HttpStreamInvalidArgumentException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamNoStreamAvailableException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamNoStreamAvailableException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamStreamReadException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamStreamReadException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamStreamSeekException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamStreamSeekException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamStreamTellException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamStreamTellException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamStreamWriteException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamStreamWriteException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamUnreadableStreamException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamUnreadableStreamException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamUnseekableStreamException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamUnseekableStreamException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Stream/Throwable/Exception/HttpStreamUnwritableStreamException.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 { HttpStreamRuntimeException } from './Abstract/HttpStreamRuntimeException.js';
+
+export class HttpStreamUnwritableStreamException extends HttpStreamRuntimeException {}

package/src/Valkyrja/Http/Message/Throwable/Contract/HttpMessageThrowable.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 { HttpThrowable } from '../../../Throwable/Contract/HttpThrowable.js';
+
+export type HttpMessageThrowable = HttpThrowable;

package/src/Valkyrja/Http/Message/Throwable/Exception/Abstract/HttpMessageInvalidArgumentException.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 { HttpMessageThrowable } from '../../Contract/HttpMessageThrowable.js';
+import { HttpInvalidArgumentException } from '../../../../Throwable/Exception/Abstract/HttpInvalidArgumentException.js';
+
+export abstract class HttpMessageInvalidArgumentException
+    extends HttpInvalidArgumentException
+    implements HttpMessageThrowable {}

package/src/Valkyrja/Http/Message/Throwable/Exception/Abstract/HttpMessageRuntimeException.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 { HttpMessageThrowable } from '../../Contract/HttpMessageThrowable.js';
+import { HttpRuntimeException } from '../../../../Throwable/Exception/Abstract/HttpRuntimeException.js';
+
+export abstract class HttpMessageRuntimeException extends HttpRuntimeException implements HttpMessageThrowable {}

package/src/Valkyrja/Http/Message/Throwable/Exception/HttpNotFoundResponseException.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 { HeaderCollectionContract } from '../../Header/Collection/Contract/HeaderCollectionContract.js';
+import { HttpResponseException } from './HttpResponseException.js';
+import { StatusCode } from '../../Enum/StatusCode.js';
+
+export class HttpNotFoundResponseException extends HttpResponseException {
+    constructor(
+        statusCode: StatusCode | null = null,
+        message: string | null = null,
+        headers: HeaderCollectionContract | null = null,
+    ) {
+        super(statusCode ?? StatusCode.NOT_FOUND, message, headers);
+    }
+}

package/src/Valkyrja/Http/Message/Throwable/Exception/HttpRedirectResponseException.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 '../../Response/Contract/ResponseContract.js';
+import type { UriContract } from '../../Uri/Contract/UriContract.js';
+import type { HeaderCollectionContract } from '../../Header/Collection/Contract/HeaderCollectionContract.js';
+import { HttpResponseException } from './HttpResponseException.js';
+import { HeaderCollection } from '../../Header/Collection/HeaderCollection.js';
+import { RedirectResponse } from '../../Response/RedirectResponse.js';
+import { Uri } from '../../Uri/Uri.js';
+import { Scheme } from '../../Uri/Enum/Scheme.js';
+import { StatusCode } from '../../Enum/StatusCode.js';
+
+export class HttpRedirectResponseException extends HttpResponseException {
+    protected uri: UriContract;
+
+    constructor(
+        uri: UriContract | null = null,
+        statusCode: StatusCode | null = null,
+        headers: HeaderCollectionContract | null = null,
+        response: ResponseContract | null = null,
+    ) {
+        const resolvedStatus = statusCode ?? StatusCode.FOUND;
+        const resolvedHeaders = headers ?? new HeaderCollection();
+        const resolvedUri = uri ?? new Uri(Scheme.EMPTY, '', '', '', 0, '/');
+        const resolvedResponse =
+            response ?? RedirectResponse.createFromUri(resolvedUri, resolvedStatus, resolvedHeaders);
+
+        super(resolvedStatus, 'Redirect', resolvedHeaders, resolvedResponse);
+        this.uri = resolvedUri;
+    }
+
+    getUri(): UriContract {
+        return this.uri;
+    }
+}

package/src/Valkyrja/Http/Message/Throwable/Exception/HttpResponseException.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 { ResponseContract } from '../../Response/Contract/ResponseContract.js';
+import type { HeaderCollectionContract } from '../../Header/Collection/Contract/HeaderCollectionContract.js';
+import { HttpMessageRuntimeException } from './Abstract/HttpMessageRuntimeException.js';
+import { HeaderCollection } from '../../Header/Collection/HeaderCollection.js';
+import { StatusCode } from '../../Enum/StatusCode.js';
+
+export class HttpResponseException extends HttpMessageRuntimeException {
+    protected statusCode: StatusCode;
+    protected headers: HeaderCollectionContract;
+    protected response: ResponseContract | null;
+
+    constructor(
+        statusCode: StatusCode | null = null,
+        message: string | null = null,
+        headers: HeaderCollectionContract | null = null,
+        response: ResponseContract | null = null,
+    ) {
+        super(message ?? '');
+        this.statusCode = statusCode ?? response?.getStatusCode() ?? StatusCode.INTERNAL_SERVER_ERROR;
+        this.headers = headers ?? new HeaderCollection();
+        this.response = response?.withStatusCode(this.statusCode) ?? null;
+    }
+
+    getStatusCode(): StatusCode {
+        return this.statusCode;
+    }
+
+    getHeaders(): HeaderCollectionContract {
+        return this.headers;
+    }
+
+    getResponse(): ResponseContract | null {
+        return this.response;
+    }
+}

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

@@ -0,0 +1,77 @@
+/*
+ * 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 { HeaderContract } from '../Header/Contract/HeaderContract.js';
+import type { StreamContract } from '../Stream/Contract/StreamContract.js';
+import type { MessageContract } from '../Contract/MessageContract.js';
+import { ProtocolVersion } from '../Enum/ProtocolVersion.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export abstract class Message implements MessageContract {
+    protected headers!: HeaderCollectionContract;
+    protected protocolVersion: ProtocolVersion = ProtocolVersion.V1_1;
+    protected stream!: StreamContract;
+
+    getProtocolVersion(): ProtocolVersion {
+        return this.protocolVersion;
+    }
+
+    withProtocolVersion(version: ProtocolVersion): this {
+        const clone = ObjectFactory.clone(this);
+        clone.protocolVersion = version;
+        return clone;
+    }
+
+    getHeaders(): HeaderCollectionContract {
+        return this.headers;
+    }
+
+    withHeaders(headers: HeaderCollectionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.headers = headers;
+        return clone;
+    }
+
+    getBody(): StreamContract {
+        return this.stream;
+    }
+
+    withBody(body: StreamContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.stream = body;
+        clone.stream.rewind();
+        return clone;
+    }
+
+    protected setBody(body: StreamContract): void {
+        this.stream = body;
+    }
+
+    static injectHeader(
+        header: HeaderContract,
+        headers: HeaderCollectionContract,
+        override: boolean = false,
+    ): HeaderCollectionContract {
+        const headerName = header.getNormalizedName();
+        const newHeader =
+            override || !headers.has(headerName)
+                ? header
+                : headers.get(headerName).withAddedValues(...header.getValues());
+        return headers.withHeader(newHeader);
+    }
+
+    protected injectHeader(
+        header: HeaderContract,
+        headers: HeaderCollectionContract,
+        override: boolean = false,
+    ): HeaderCollectionContract {
+        return Message.injectHeader(header, headers, override);
+    }
+}

package/src/Valkyrja/Http/Message/Uri/Contract/UriContract.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 { Scheme } from '../Enum/Scheme.js';
+
+export interface UriContract {
+    getScheme(): Scheme;
+    isSecure(): boolean;
+    getAuthority(): string;
+    getUsername(): string;
+    getPassword(): string;
+    getUserInfo(): string;
+    getHost(): string;
+    hasPort(): boolean;
+    getPort(): number;
+    getHostPort(): string;
+    getSchemeHostPort(): string;
+    getPath(): string;
+    getQuery(): string;
+    getFragment(): string;
+    withScheme(scheme: Scheme): this;
+    withUsername(username: string): this;
+    withPassword(password: string): this;
+    withUserInfo(user: string, password?: string): this;
+    withHost(host: string): this;
+    withPort(port: number): this;
+    withPath(path: string): this;
+    withQuery(query: string): this;
+    withFragment(fragment: string): this;
+    toString(): string;
+}

package/src/Valkyrja/Http/Message/Uri/Data/HostPortAccumulator.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.
+ */
+
+export class HostPortAccumulator {
+    constructor(
+        public host: string = '',
+        public port: number = 0,
+    ) {}
+}

package/src/Valkyrja/Http/Message/Uri/Enum/Scheme.ts

@@ -0,0 +1,14 @@
+/*
+ * 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.
+ */
+
+export enum Scheme {
+    EMPTY = '',
+    HTTP = 'http',
+    HTTPS = 'https',
+}