raiton 3.0.1 → 3.1.0

package/source/types/middleware.ts

@@ -1,18 +1,18 @@
-import {RequestContext} from "@/core/context";
+import {RequestContext} from "../core/context";
 
 
-export type NextCallable = () => Promise<void>
+export type MiddlewareNextCallable = () => Promise<void>
 
 export interface MiddlewareSetupInterface {
     setup: any,
     name: string;
 }
 
-export interface MiddlewareParameters {
+export interface MiddlewareParametersInterface {
     context: RequestContext;
-    next: NextCallable;
+    next: MiddlewareNextCallable;
 }
 
-export type MiddlewareCallable = (parameters: MiddlewareParameters) => Promise<any> | void
+export type MiddlewareCallable = (parameters: MiddlewareParametersInterface) => Promise<any> | void
 
 export type MiddlewareType = MiddlewareCallable | MiddlewareSetupInterface

package/source/types/plugin.ts

@@ -1,10 +1,8 @@
-import {PluginScope} from "@/core/plugins/scope";
+import {PluginScope} from "../core/plugins/scope";
 
-export type PluginFn = (
-  scope: PluginScope
-) => Promise<void> | void
+export type PluginCallable = (scope: PluginScope) => Promise<void> | void
 
-export interface Plugin {
+export interface PluginInterface {
   name?: string
-  setup: PluginFn
+  setup: PluginCallable
 }

package/source/types/raiton.ts

@@ -1,7 +1,7 @@
-import {BuilderHMRDeclaration} from "@/types/builder";
+import {BuilderHMRDeclarationInterface} from "./builder";
 
-export interface RaitonSignalMap {
+export interface RaitonSignalMapInterface {
     ready?: undefined;
     errors: any;
-    'hmr:controller': BuilderHMRDeclaration;
+    'hmr:controller': BuilderHMRDeclarationInterface;
 }

package/source/types/responses.ts

@@ -1,16 +1,11 @@
-import {HttpStatus} from "@/sdk/enums/http-status.enum";
+import {HttpStatus} from "../sdk/enums/http-status.enum";
+import {ParseableEntriesType, ParseableType} from "./parseable";
 
 export interface HttpResponseBaseInterface {
     message: string;
     statusCode?: HttpStatus;
 }
 
-export interface HttpResponseInterface<T = any> extends HttpResponseBaseInterface{
-    error?: boolean;
-    errorStack?: Error | ErrorResponseInterface[];
-    data?: T
-}
-
 export interface ErrorResponseInterface {
     id: string;
     message?: string;
@@ -18,3 +13,11 @@ export interface ErrorResponseInterface {
     statusCode?: HttpStatus;
     error?: Error
 }
+
+export interface HttpResponseInterface<T extends ParseableType> extends ParseableEntriesType {
+    statusCode: number,
+    message?: string,
+    data?: T,
+    error?: any,
+    errorStack?: Error | ErrorResponseInterface[];
+}

package/source/types/router.ts

@@ -1,11 +1,11 @@
-import {RequestContext} from "@/core/context";
-import {HttpMethod} from "@/sdk";
+import {RequestContext} from "../core/context";
+import {HttpMethod} from "../sdk";
 
-export type RouteHandler = (ctx: RequestContext) => Promise<any> | any
+export type RouteHandlerCallable = (ctx: RequestContext) => Promise<any> | any
 
-export interface RouteDefinition {
+export interface RouteDefinitionInterface {
     method: HttpMethod
     path: string
     version?: string
-    handler: RouteHandler
+    handler: RouteHandlerCallable
 }

package/source/types/runtime.ts

@@ -1,4 +1,4 @@
-import {RuntimeType} from "@/sdk/enums/runtime.enum";
+import {RuntimeType} from "../sdk/enums/runtime.enum";
 
 export interface RuntimeServerInterface {
     listen(port: number, hostname?: string): Promise<void>

package/source/types/server.ts

@@ -1,10 +1,10 @@
 export interface ServerInterface {
-    readonly options: ServerOptions;
+    readonly options: ServerOptionsInterface;
 
-    option<K extends keyof ServerOptions>(key: K): ServerOptions[K];
+    option<K extends keyof ServerOptionsInterface>(key: K): ServerOptionsInterface[K];
 }
 
-export interface ServerOptions {
+export interface ServerOptionsInterface {
     os?: string;
     arch?: string;
     ip?: string;

package/source/types/thread.ts

@@ -1,9 +1,9 @@
-import {BuilderInterface} from "@/types/builder";
-import {RuntimeAdapterInterface} from "@/types/runtime";
-import {ApplicationInterface} from "@/types/application";
-import {RuntimeType} from "@/sdk/enums/runtime.enum";
+import {BuilderInterface} from "./builder";
+import {RuntimeAdapterInterface} from "./runtime";
+import {ApplicationInterface} from "./application";
+import {RuntimeType} from "../sdk/enums/runtime.enum";
 
-export interface ThreadSetupOptions {
+export interface ThreadSetupOptionsInterface {
     application: ApplicationInterface;
     runtime?: RuntimeType
 }
@@ -14,7 +14,7 @@ export interface ThreadInterface {
     readonly appDir: string;
     readonly builder: BuilderInterface;
 
-    setup(options: ThreadSetupOptions): this
+    setup(options: ThreadSetupOptionsInterface): this
 
     run(): Promise<this>;
 
@@ -28,4 +28,4 @@ export interface ThreadInterface {
 }
 
 
-export interface ThreadOptions{}
+export interface ThreadOptionsInterface {}

package/source/types/utilities.ts

@@ -1,4 +1,4 @@
-export interface FileSizeFormated {
+export interface FileSizeFormatedInterface {
     size: number;
     unit: string;
 }

package/source/types/values.ts

@@ -1,3 +1,3 @@
 
-export type IString = string | Object | null | undefined;
-export type IStringable = IString | IString[] | Promise<IString | IString[]>;
+export type StringType = string | Object | null | undefined;
+export type StringableType = StringType | StringType[] | Promise<StringType | StringType[]>;

package/source/types/access-guards.ts

@@ -1,4 +0,0 @@
-export interface IAccessGuardDeclaration {
-    credential?: boolean;
-    capabilities?: string[];
-}

package/source/types/http-responses.ts

@@ -1,8 +0,0 @@
-import {ParseableEntriesType, ParseableType} from "./parseable";
-
-export interface IHttpResponse<T extends ParseableType> extends ParseableEntriesType {
-    statusCode: number,
-    message?: string,
-    data?: T,
-    error?: any,
-}

package/source/types/scheme.ts

@@ -1,153 +0,0 @@
-import {TObject, TProperties, TSchema} from "@sinclair/typebox";
-
-
-export interface ISchemePropertyOptions {
-    optional?: boolean;
-}
-
-/**
- * The `ISchematic` interface provides a structured contract for managing and constructing schemas
- * that define the shape of request bodies, parameters, query strings, and response structures.
- * It allows dynamic assignment of schema properties and the retrieval of constructed schema configurations.
- *
- * @template TBody The schema type defining the request body.
- * @template TParams The schema type defining the request parameters.
- * @template TQuery The schema type defining the query string.
- * @template TResponse The schema type defining the response structure, indexed by HTTP status codes.
- */
-export interface IScheme<
-    TBody extends TSchema | undefined = undefined,
-    TParams extends TSchema | undefined = undefined,
-    TQuery extends TSchema | undefined = undefined,
-    TResponse extends Record<number, TSchema> | undefined = undefined
-> {
-    /**
-     * Retrieves the value of the `$body` property.
-     *
-     * @return {TBody | undefined} The body content of type `TBody` or `undefined` if not set.
-     */
-    get $body(): TBody | undefined;
-
-    /**
-     * Updates the body of the request with a specified key-value pair.
-     *
-     * @param {string} key - The key to be added or updated in the body of the request.
-     * @param {TProperties} value - The value associated with the specified key.
-     * @return {this} The current instance to allow method chaining.
-     */
-    body(key: string, value: TProperties): this;
-
-    /**
-     * Retrieves the current value of `$params`.
-     *
-     * This method returns the parameter(s) associated with the instance.
-     * It may return undefined if no parameters are set.
-     *
-     * @return {TParams | undefined} The current parameters or undefined if none are set.
-     */
-    get $params(): TParams | undefined;
-
-    /**
-     * Assigns a key-value pair to the parameters of the current instance.
-     *
-     * @param {string} key - The key for the parameter to be set.
-     * @param {TProperties} value - The value associated with the specified key.
-     * @return {this} The current instance with the updated parameter.
-     */
-    params(key: string, value: TProperties): this;
-
-    /**
-     * Retrieves the query string associated with the current object.
-     *
-     * @return {TQuery | undefined} The query string if defined, otherwise undefined.
-     */
-    get $querystring(): TQuery | undefined;
-
-    /**
-     * Updates or sets a query string parameter with the specified key and value.
-     * If the query string already contains the key, its value will be updated.
-     *
-     * @param {string} key - The key of the query string parameter to be updated or added.
-     * @param {TProperties} value - The value to be set for the specified query string key.
-     * @return {this} The current instance to allow for method chaining.
-     */
-    querystring(key: string, value: TProperties): this;
-
-    /**
-     * Retrieves the response object associated with the instance.
-     *
-     * @return {TResponse | undefined} The response object if it exists, otherwise undefined.
-     */
-    get $response(): TResponse | undefined;
-
-    /**
-     * Stores a key-value pair in the response object and returns the current instance for chaining.
-     *
-     * @param {number} key - The unique identifier for the value to be stored.
-     * @param {TProperties} value - The value to store associated with the provided key.
-     * @return {this} Returns the current instance to allow method chaining.
-     */
-    response(key: number, value: TProperties): this;
-
-    /**
-     * Provides the schema options for handling the request and response structure.
-     *
-     * @return {ISchemeOptions<TBody, TParams, TQuery, TResponse>} The schema options defining the types for body, params, query, and response.
-     */
-    schema(): ISchemeOptions<TBody, TParams, TQuery, TResponse>;
-}
-
-/**
- * Interface representing the schema configuration for various aspects of a request-response process.
- *
- * @template TBody Represents the schema for the request body. Defaults to undefined if not specified.
- * @template TParams Represents the schema for request parameters. Defaults to undefined if not specified.
- * @template TQuery Represents the schema for query string parameters. Defaults to undefined if not specified.
- * @template TResponse Represents the schema for response objects, mapped by status codes. Defaults to undefined if not specified.
- *
- * @property {TBody} [body] Optional schema definition for the request body.
- * @property {TParams} [params] Optional schema definition for the request parameters.
- * @property {TQuery} [querystring] Optional schema definition for query string parameters.
- * @property {TResponse} [response] Optional schema definition for response objects, associated with HTTP status codes.
- */
-export interface ISchemeConfig<
-    TBody extends TSchema | undefined = undefined,
-    TParams extends TSchema | undefined = undefined,
-    TQuery extends TSchema | undefined = undefined,
-    TResponse extends Record<number, TSchema> | undefined = undefined
-> {
-    body?: TBody;
-    params?: TParams;
-    querystring?: TQuery;
-    response?: TResponse;
-}
-
-/**
- * Interface representing schema options for defining request and response payloads
- * in a structured and strongly-typed manner.
- *
- * @template TBody - The type of the schema for the request body, or undefined if not applicable.
- * @template TParams - The type of the schema for the request parameters, or undefined if not applicable.
- * @template TQuery - The type of the schema for the query string, or undefined if not applicable.
- * @template TResponse - A record of HTTP status codes to their respective response schemas, or undefined if not applicable.
- *
- * @property body - Represents the schema definition for the request body.
- *                   This is an optional property and only applies if TBody is specified.
- * @property params - Represents the schema definition for the request parameters.
- *                     This is an optional property and only applies if TParams is specified.
- * @property querystring - Represents the schema definition for the query string.
- *                          This is an optional property and only applies if TQuery is specified.
- * @property response - Represents the schema definition for the response body, mapped by status code.
- *                       This is an optional property and only applies if TResponse is specified.
- */
-export interface ISchemeOptions<
-    TBody extends TSchema | undefined = undefined,
-    TParams extends TSchema | undefined = undefined,
-    TQuery extends TSchema | undefined = undefined,
-    TResponse extends Record<number, TSchema> | undefined = undefined
-> {
-    body?: TObject<NonNullable<TBody>> | undefined;
-    params?: TObject<NonNullable<TParams>> | undefined;
-    querystring?: TObject<NonNullable<TQuery>> | undefined;
-    response?: TObject<NonNullable<TResponse>> | undefined;
-}