@valkyrjaio/valkyrja 26.0.0

package/src/Valkyrja/Http/Message/Header/Factory/HeaderFactory.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 { HttpHeaderInvalidNameException } from '../Throwable/Exception/HttpHeaderInvalidNameException.js';
+import { HttpHeaderInvalidValueException } from '../Throwable/Exception/HttpHeaderInvalidValueException.js';
+
+export abstract class HeaderFactory {
+    static marshalHeaders(server: Record<string, string | number>): Record<string, string> {
+        const headers: Record<string, string> = {};
+        for (const [key, value] of Object.entries(server)) {
+            const lower = key.toLowerCase();
+            if (lower.startsWith('http_')) {
+                const name = lower.slice(5).replaceAll('_', '-');
+                headers[name] = String(value);
+            } else if (lower === 'content_type' || lower === 'content_length' || lower === 'content_md5') {
+                const name = lower.replaceAll('_', '-');
+                headers[name] = String(value);
+            }
+        }
+        return headers;
+    }
+
+    static filterValue(value: string): string {
+        let result = '';
+        for (let i = 0; i < value.length; i++) {
+            const ascii = value.charCodeAt(i);
+            if (ascii === 13) {
+                const lf = value.charCodeAt(i + 1);
+                const ws = value.charCodeAt(i + 2);
+                if (lf === 10 && (ws === 9 || ws === 32)) {
+                    result += (value[i] ?? '') + (value[i + 1] ?? '');
+                    i++;
+                }
+                continue;
+            }
+            if (!HeaderFactory.isInvalidValueAscii(ascii)) {
+                result += value[i] ?? '';
+            }
+        }
+        return result;
+    }
+
+    static assertValidValue(value: string): void {
+        if (!HeaderFactory.isValidValue(value)) {
+            throw new HttpHeaderInvalidValueException(`"${value}" is not valid header value`);
+        }
+    }
+
+    static isValidValue(value: string): boolean {
+        if (/(?:(?:(?<!\r)\n)|(?:\r(?!\n))|(?:\r\n(?![ \t])))/.test(value)) {
+            return false;
+        }
+        // eslint-disable-next-line no-control-regex
+        if (/[^\x09\x0a\x0d\x20-\x7E\x80-\xFE]/.test(value)) {
+            return false;
+        }
+        return true;
+    }
+
+    static assertValidName(name: string): void {
+        if (!HeaderFactory.isValidName(name)) {
+            throw new HttpHeaderInvalidNameException(`"${name}" is not valid header name`);
+        }
+    }
+
+    static isValidName(name: string): boolean {
+        return name !== '' && /^[!#$%&'*+\-.0-9A-Z^_`a-z|~]+$/.test(name);
+    }
+
+    protected static isInvalidValueAscii(ascii: number): boolean {
+        return (ascii < 32 && ascii !== 9 && ascii !== 10 && ascii !== 13) || ascii === 127 || ascii === 255;
+    }
+}

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

@@ -0,0 +1,104 @@
+/*
+ * 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 { HeaderContract } from './Contract/HeaderContract.js';
+import type { ValueContract } from './Value/Contract/ValueContract.js';
+import { HeaderFactory } from './Factory/HeaderFactory.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Header implements HeaderContract {
+    protected name: string;
+    protected normalizedName: string;
+    protected values: Array<ValueContract | string> = [];
+
+    constructor(name: string, ...values: Array<ValueContract | string>) {
+        HeaderFactory.assertValidName(name);
+        this.name = name;
+        this.normalizedName = name.toLowerCase();
+        this.updateValues(...values);
+    }
+
+    static fromValue(value: string): Header {
+        const deliminator = ':';
+        let name = value;
+        let valuesStr = '';
+        if (value.includes(deliminator)) {
+            const idx = value.indexOf(deliminator);
+            name = value.slice(0, idx);
+            valuesStr = value.slice(idx + 1);
+        }
+
+        const valueDeliminator = ',';
+        const parts: Array<ValueContract | string> = valuesStr.includes(valueDeliminator)
+            ? valuesStr.split(valueDeliminator).map((v) => v.trim())
+            : [valuesStr.trim()];
+
+        return new Header(name.trim(), ...parts);
+    }
+
+    getName(): string {
+        return this.name;
+    }
+    getNormalizedName(): string {
+        return this.normalizedName;
+    }
+
+    withName(name: string): this {
+        const clone = ObjectFactory.clone(this);
+        HeaderFactory.assertValidName(name);
+        clone.name = name;
+        clone.normalizedName = name.toLowerCase();
+        return clone;
+    }
+
+    getValues(): Array<ValueContract | string> {
+        return this.values;
+    }
+
+    withValues(...values: Array<ValueContract | string>): this {
+        const clone = ObjectFactory.clone(this);
+        clone.values = this.filterValues(...values);
+        return clone;
+    }
+
+    withAddedValues(...values: Array<ValueContract | string>): this {
+        const clone = ObjectFactory.clone(this);
+        clone.values = [...this.values, ...this.filterValues(...values)];
+        return clone;
+    }
+
+    getHeaderLine(): string {
+        return this.name + ': ' + this.valuesToString();
+    }
+
+    toString(): string {
+        return this.getHeaderLine();
+    }
+
+    protected updateValues(...values: Array<ValueContract | string>): void {
+        this.values = this.filterValues(...values);
+    }
+
+    protected valuesToString(): string {
+        return this.values
+            .map((v) => (typeof v === 'string' ? v : v.toString()).trim())
+            .filter((s) => s !== '')
+            .join(', ');
+    }
+
+    protected filterValues(...values: Array<ValueContract | string>): Array<ValueContract | string> {
+        return values.map((v) => {
+            if (typeof v === 'string') {
+                v = HeaderFactory.filterValue(v);
+                HeaderFactory.assertValidValue(v);
+            }
+            return v;
+        });
+    }
+}

package/src/Valkyrja/Http/Message/Header/Location.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 { ValueContract } from './Value/Contract/ValueContract.js';
+import { Header } from './Header.js';
+import { HeaderName } from '../Constant/HeaderName.js';
+
+export class Location extends Header {
+    constructor(...values: Array<ValueContract | string>) {
+        super(HeaderName.LOCATION, ...values);
+    }
+}

package/src/Valkyrja/Http/Message/Header/Referer.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 { ValueContract } from './Value/Contract/ValueContract.js';
+import { Header } from './Header.js';
+import { HeaderName } from '../Constant/HeaderName.js';
+
+export class Referer extends Header {
+    constructor(...values: Array<ValueContract | string>) {
+        super(HeaderName.REFERER, ...values);
+    }
+}

package/src/Valkyrja/Http/Message/Header/SetCookie.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 { CookieContract } from './Value/Contract/CookieContract.js';
+import { Header } from './Header.js';
+import { HeaderName } from '../Constant/HeaderName.js';
+
+export class SetCookie extends Header {
+    constructor(...values: CookieContract[]) {
+        super(HeaderName.SET_COOKIE, ...values);
+    }
+}

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

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

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

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

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

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

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

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

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

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

package/src/Valkyrja/Http/Message/Header/Value/Component/Component.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 { ComponentContract } from './Contract/ComponentContract.js';
+import { ObjectFactory } from '../../../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Component implements ComponentContract {
+    constructor(
+        protected token: string,
+        protected text: string = '',
+    ) {
+        this.token = token.trim();
+        this.text = text.trim();
+    }
+
+    static fromValue(value: string): Component {
+        const deliminator = '=';
+        if (value.includes(deliminator)) {
+            const [token, ...rest] = value.split(deliminator);
+            return new Component(token?.trim() ?? '', rest.join(deliminator).trim());
+        }
+        return new Component(value.trim());
+    }
+
+    getToken(): string {
+        return this.token;
+    }
+
+    withToken(token: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.token = token.trim();
+        return clone;
+    }
+
+    getText(): string {
+        return this.text;
+    }
+
+    withText(text: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.text = text.trim();
+        return clone;
+    }
+
+    toString(): string {
+        return this.token !== '' && this.text !== '' ? `${this.token}=${this.text}` : this.token;
+    }
+}

package/src/Valkyrja/Http/Message/Header/Value/Component/Contract/ComponentContract.ts

@@ -0,0 +1,16 @@
+/*
+ * 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 interface ComponentContract {
+    getToken(): string;
+    withToken(token: string): this;
+    getText(): string;
+    withText(text: string): this;
+    toString(): string;
+}

package/src/Valkyrja/Http/Message/Header/Value/Contract/CookieContract.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { SameSite } from '../../../Enum/SameSite.js';
+import type { ValueContract } from './ValueContract.js';
+
+export interface CookieContract extends ValueContract {
+    delete(): this;
+    getMaxAge(): number;
+    getName(): string;
+    withName(name: string): this;
+    getValue(): string;
+    withValue(value: string): this;
+    getExpire(): number;
+    withExpire(expire: number): this;
+    getPath(): string;
+    withPath(path: string): this;
+    getDomain(): string;
+    withDomain(domain: string): this;
+    isSecure(): boolean;
+    withSecure(secure: boolean): this;
+    isHttpOnly(): boolean;
+    withHttpOnly(httpOnly: boolean): this;
+    isRaw(): boolean;
+    withRaw(raw: boolean): this;
+    getSameSite(): SameSite;
+    withSameSite(sameSite: SameSite): this;
+    toString(): string;
+}

package/src/Valkyrja/Http/Message/Header/Value/Contract/ValueContract.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 { ComponentContract } from '../Component/Contract/ComponentContract.js';
+
+export interface ValueContract {
+    getComponents(): Array<ComponentContract | string>;
+    withComponents(...components: Array<ComponentContract | string>): this;
+    withAddedComponents(...components: Array<ComponentContract | string>): this;
+    toString(): string;
+}

package/src/Valkyrja/Http/Message/Header/Value/Cookie.ts

@@ -0,0 +1,165 @@
+/*
+ * 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 { CookieContract } from './Contract/CookieContract.js';
+import { SameSite } from '../../Enum/SameSite.js';
+import { Value } from './Value.js';
+import { ObjectFactory } from '../../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Cookie extends Value implements CookieContract {
+    constructor(
+        protected name: string,
+        protected value: string = '',
+        protected expire: number = 0,
+        protected path: string = '/',
+        protected domain: string = '',
+        protected secure: boolean = false,
+        protected httpOnly: boolean = true,
+        protected raw: boolean = false,
+        protected sameSite: SameSite = SameSite.LAX,
+        protected deleted: boolean = false,
+    ) {
+        super();
+    }
+
+    delete(): this {
+        const clone = ObjectFactory.clone(this);
+        clone.deleted = true;
+        return clone;
+    }
+
+    getMaxAge(): number {
+        return this.expire > 0 ? this.expire - Math.floor(Date.now() / 1000) : 0;
+    }
+
+    getName(): string {
+        return this.name;
+    }
+
+    withName(name: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.name = name;
+        return clone;
+    }
+
+    getValue(): string {
+        return this.value;
+    }
+
+    withValue(value: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.value = value;
+        return clone;
+    }
+
+    getExpire(): number {
+        return this.expire;
+    }
+
+    withExpire(expire: number): this {
+        const clone = ObjectFactory.clone(this);
+        clone.expire = expire;
+        return clone;
+    }
+
+    getPath(): string {
+        return this.path;
+    }
+
+    withPath(path: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.path = path;
+        return clone;
+    }
+
+    getDomain(): string {
+        return this.domain;
+    }
+
+    withDomain(domain: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.domain = domain;
+        return clone;
+    }
+
+    isSecure(): boolean {
+        return this.secure;
+    }
+
+    withSecure(secure: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.secure = secure;
+        return clone;
+    }
+
+    isHttpOnly(): boolean {
+        return this.httpOnly;
+    }
+
+    withHttpOnly(httpOnly: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.httpOnly = httpOnly;
+        return clone;
+    }
+
+    isRaw(): boolean {
+        return this.raw;
+    }
+
+    withRaw(raw: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.raw = raw;
+        return clone;
+    }
+
+    getSameSite(): SameSite {
+        return this.sameSite;
+    }
+
+    withSameSite(sameSite: SameSite): this {
+        const clone = ObjectFactory.clone(this);
+        clone.sameSite = sameSite;
+        return clone;
+    }
+
+    override toString(): string {
+        let value = this.value;
+        let expire = this.expire;
+        let maxAge = this.getMaxAge();
+
+        if (this.deleted) {
+            const pastTime = Math.floor(Date.now() / 1000) - 31536001;
+            expire = pastTime;
+            maxAge = -31536001;
+            value = 'delete';
+        }
+
+        const parts: string[] = [`${encodeURIComponent(this.name)}=${encodeURIComponent(value)}`];
+
+        if (expire !== 0) {
+            parts.push(`expires=${new Date(expire * 1000).toUTCString()}`);
+            parts.push(`max-age=${String(maxAge)}`);
+        }
+
+        parts.push(`path=${this.path}`);
+
+        if (this.domain !== '') {
+            parts.push(`domain=${this.domain}`);
+        }
+        if (this.secure) {
+            parts.push('secure');
+        }
+        if (this.httpOnly) {
+            parts.push('httponly');
+        }
+        parts.push(`samesite=${this.sameSite}`);
+
+        return parts.join('; ');
+    }
+}