hightjs 0.5.3 → 0.5.4

package/dist/types.d.ts

@@ -0,0 +1,192 @@
+import type { ComponentType } from 'react';
+import type { GenericRequest } from './types/framework';
+import { HightJSRequest, HightJSResponse } from "./api/http";
+import { WebSocket } from 'ws';
+import { IncomingMessage } from 'http';
+export interface WebSocketContext {
+    ws: WebSocket;
+    req: IncomingMessage;
+    hightReq: HightJSRequest;
+    url: URL;
+    params: Record<string, string>;
+    query: Record<string, string>;
+    send: (data: any) => void;
+    close: (code?: number, reason?: string) => void;
+    broadcast: (data: any, exclude?: WebSocket[]) => void;
+}
+export interface HightJSOptions {
+    dev?: boolean;
+    hostname?: string;
+    port?: number;
+    dir?: string;
+    framework?: 'express' | 'fastify' | 'native';
+    ssl?: {
+        redirectPort: number;
+        key: string;
+        cert: string;
+        ca?: string;
+    };
+}
+/**
+ * Interface para as configurações avançadas do servidor HightJS.
+ * Essas configurações podem ser definidas no arquivo hightjs.config.js
+ */
+export interface HightConfig {
+    /**
+     * Limita o número máximo de headers HTTP permitidos por requisição.
+     * Padrão: 100
+     */
+    maxHeadersCount?: number;
+    /**
+     * Timeout em milissegundos para receber os headers HTTP.
+     * Padrão: 60000 (60 segundos)
+     */
+    headersTimeout?: number;
+    /**
+     * Timeout em milissegundos para uma requisição completa.
+     * Padrão: 30000 (30 segundos)
+     */
+    requestTimeout?: number;
+    /**
+     * Timeout geral do servidor em milissegundos.
+     * Padrão: 35000 (35 segundos)
+     */
+    serverTimeout?: number;
+    /**
+     * Timeout por requisição individual em milissegundos.
+     * Padrão: 30000 (30 segundos)
+     */
+    individualRequestTimeout?: number;
+    /**
+     * Tamanho máximo permitido para a URL em caracteres.
+     * Padrão: 2048
+     */
+    maxUrlLength?: number;
+    /**
+     * Habilita o log de acesso HTTP (ex: GET /api/users 200 15ms).
+     * Padrão: false
+     */
+    accessLogging?: boolean;
+    /**
+     * Configurações de CORS (Cross-Origin Resource Sharing).
+     * Define quais origens podem acessar seus recursos.
+     */
+    cors?: {
+        /**
+         * Origens permitidas. Pode ser:
+         * - Uma string específica: 'https://exemplo.com'
+         * - Um array de strings: ['https://exemplo.com', 'https://outro.com']
+         * - Um wildcard: '*' (permite todas as origens - não recomendado em produção)
+         * - Uma função que retorna boolean: (origin) => origin.endsWith('.exemplo.com')
+         */
+        origin?: string | string[] | ((origin: string) => boolean);
+        /**
+         * Métodos HTTP permitidos.
+         * Padrão: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS']
+         */
+        methods?: string[];
+        /**
+         * Headers permitidos nas requisições.
+         * Padrão: ['Content-Type', 'Authorization']
+         */
+        allowedHeaders?: string[];
+        /**
+         * Headers que serão expostos ao cliente.
+         * Padrão: []
+         */
+        exposedHeaders?: string[];
+        /**
+         * Permite o envio de credenciais (cookies, headers de autenticação).
+         * Padrão: false
+         */
+        credentials?: boolean;
+        /**
+         * Tempo em segundos que o navegador deve cachear a resposta preflight.
+         * Padrão: 86400 (24 horas)
+         */
+        maxAge?: number;
+        /**
+         * Habilita ou desabilita completamente o CORS.
+         * Padrão: false
+         */
+        enabled?: boolean;
+    };
+}
+/**
+ * Tipo da função de configuração que pode ser exportada no hightjs.config.js
+ */
+export type HightConfigFunction = (phase: string, context: {
+    defaultConfig: HightConfig;
+}) => HightConfig | Promise<HightConfig>;
+export interface Metadata {
+    title?: string;
+    description?: string;
+    keywords?: string | string[];
+    author?: string;
+    favicon?: string;
+    viewport?: string;
+    themeColor?: string;
+    canonical?: string;
+    robots?: string;
+    openGraph?: {
+        title?: string;
+        description?: string;
+        type?: string;
+        url?: string;
+        image?: string | {
+            url: string;
+            width?: number;
+            height?: number;
+            alt?: string;
+        };
+        siteName?: string;
+        locale?: string;
+    };
+    twitter?: {
+        card?: 'summary' | 'summary_large_image' | 'app' | 'player';
+        site?: string;
+        creator?: string;
+        title?: string;
+        description?: string;
+        image?: string;
+        imageAlt?: string;
+    };
+    language?: string;
+    charset?: string;
+    appleTouchIcon?: string;
+    manifest?: string;
+    other?: Record<string, string>;
+}
+export interface RouteConfig {
+    pattern: string;
+    component: ComponentType<any>;
+    generateMetadata?: (params: any, req: GenericRequest) => Promise<Metadata> | Metadata;
+}
+export type RequestHandler = (req: any, res: any) => Promise<void>;
+/**
+ * Define o formato de uma função que manipula uma rota da API.
+ */
+export type BackendHandler = (request: HightJSRequest, // HWebRequest será importado onde necessário
+params: {
+    [key: string]: string;
+}) => Promise<HightJSResponse> | HightJSResponse;
+export type HightMiddleware = (request: HightJSRequest, // HWebRequest será importado onde necessário
+params: {
+    [key: string]: string;
+}, next: () => Promise<HightJSResponse>) => Promise<HightJSResponse> | HightJSResponse;
+/**
+ * Define o formato de uma função que manipula uma rota WebSocket.
+ */
+export type WebSocketHandler = (context: WebSocketContext) => Promise<void> | void;
+/**
+ * Define a estrutura de cada rota da API, com suporte para métodos HTTP e WebSocket.
+ */
+export interface BackendRouteConfig {
+    pattern: string;
+    GET?: BackendHandler;
+    POST?: BackendHandler;
+    PUT?: BackendHandler;
+    DELETE?: BackendHandler;
+    WS?: WebSocketHandler;
+    middleware?: HightMiddleware[];
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hightjs",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "HightJS is a high-level framework for building web applications with ease and speed. It provides a robust set of tools and features to streamline development and enhance productivity.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",