npm - fullstx - Versions diffs - 1.0.0 - Mend

fullstx 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (83) hide show

package/README.md +86 -0
package/bin/create.js +68 -0
package/bin/generate.js +78 -0
package/coverage/clover.xml +1356 -0
package/coverage/coverage-final.json +30 -0
package/coverage/lcov-report/base.css +224 -0
package/coverage/lcov-report/block-navigation.js +87 -0
package/coverage/lcov-report/favicon.png +0 -0
package/coverage/lcov-report/fullstx/index.html +146 -0
package/coverage/lcov-report/fullstx/index.js.html +379 -0
package/coverage/lcov-report/fullstx/lib/application.js.html +1840 -0
package/coverage/lcov-report/fullstx/lib/browser-sync.js.html +199 -0
package/coverage/lcov-report/fullstx/lib/database.js.html +535 -0
package/coverage/lcov-report/fullstx/lib/errors.js.html +154 -0
package/coverage/lcov-report/fullstx/lib/features/hooks.js.html +151 -0
package/coverage/lcov-report/fullstx/lib/features/index.html +176 -0
package/coverage/lcov-report/fullstx/lib/features/jwt.js.html +214 -0
package/coverage/lcov-report/fullstx/lib/features/plugins.js.html +172 -0
package/coverage/lcov-report/fullstx/lib/features/routing.js.html +211 -0
package/coverage/lcov-report/fullstx/lib/features/utils.js.html +1216 -0
package/coverage/lcov-report/fullstx/lib/index.html +236 -0
package/coverage/lcov-report/fullstx/lib/middlewares/apiKey.js.html +127 -0
package/coverage/lcov-report/fullstx/lib/middlewares/authorize.js.html +115 -0
package/coverage/lcov-report/fullstx/lib/middlewares/basicAuth.js.html +148 -0
package/coverage/lcov-report/fullstx/lib/middlewares/csp.js.html +124 -0
package/coverage/lcov-report/fullstx/lib/middlewares/csrf.js.html +178 -0
package/coverage/lcov-report/fullstx/lib/middlewares/htmx.js.html +157 -0
package/coverage/lcov-report/fullstx/lib/middlewares/i18n.js.html +175 -0
package/coverage/lcov-report/fullstx/lib/middlewares/index.html +281 -0
package/coverage/lcov-report/fullstx/lib/middlewares/rateLimit.js.html +169 -0
package/coverage/lcov-report/fullstx/lib/middlewares/redisCache.js.html +154 -0
package/coverage/lcov-report/fullstx/lib/middlewares/requirePermission.js.html +118 -0
package/coverage/lcov-report/fullstx/lib/middlewares/routeLocalization.js.html +118 -0
package/coverage/lcov-report/fullstx/lib/middlewares/session.js.html +133 -0
package/coverage/lcov-report/fullstx/lib/middlewares.js.html +340 -0
package/coverage/lcov-report/fullstx/lib/radix-router.js.html +418 -0
package/coverage/lcov-report/fullstx/lib/request.js.html +328 -0
package/coverage/lcov-report/fullstx/lib/response.js.html +610 -0
package/coverage/lcov-report/fullstx/lib/websocket.js.html +166 -0
package/coverage/lcov-report/fullstx/router.js.html +226 -0
package/coverage/lcov-report/fullstx/server.js.html +664 -0
package/coverage/lcov-report/index.html +161 -0
package/coverage/lcov-report/prettify.css +1 -0
package/coverage/lcov-report/prettify.js +2 -0
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +210 -0
package/coverage/lcov.info +2753 -0
package/dist/index.js +238 -0
package/dist/index.js.map +1 -0
package/dist/index.mjs +238 -0
package/dist/index.mjs.map +1 -0
package/index.d.ts +115 -0
package/index.js +98 -0
package/lib/application.js +585 -0
package/lib/browser-sync.js +38 -0
package/lib/database.js +150 -0
package/lib/errors.js +23 -0
package/lib/features/hooks.js +22 -0
package/lib/features/jwt.js +43 -0
package/lib/features/plugins.js +29 -0
package/lib/features/routing.js +42 -0
package/lib/features/utils.js +377 -0
package/lib/middlewares/apiKey.js +14 -0
package/lib/middlewares/authorize.js +10 -0
package/lib/middlewares/basicAuth.js +21 -0
package/lib/middlewares/csp.js +13 -0
package/lib/middlewares/csrf.js +31 -0
package/lib/middlewares/htmx.js +24 -0
package/lib/middlewares/i18n.js +30 -0
package/lib/middlewares/rateLimit.js +28 -0
package/lib/middlewares/redisCache.js +23 -0
package/lib/middlewares/requirePermission.js +11 -0
package/lib/middlewares/routeLocalization.js +11 -0
package/lib/middlewares/session.js +16 -0
package/lib/middlewares.js +85 -0
package/lib/radix-router.js +111 -0
package/lib/request.js +81 -0
package/lib/response.js +175 -0
package/lib/websocket.js +27 -0
package/package.json +61 -0
package/router.js +47 -0
package/server.js +193 -0
package/session.js +109 -0

package/index.d.ts ADDED Viewed

@@ -0,0 +1,115 @@
+// Type definitions for fullstx
+// Project: https://github.com/terzogenito/fullstx
+/// <reference types="node" />
+import { Server } from "http";
+export interface FullstxRequest<Body = any, Query = any, Params = any> {
+    body: Body;
+    query: Query;
+    params: Params;
+    cookies: Record<string, string>;
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+}
+export type Middleware<B = any, Q = any, P = any> = (req: FullstxRequest<B, Q, P>, res: any, next: (err?: any) => void) => void;
+export type RouteHandler<B = any, Q = any, P = any> = (req: FullstxRequest<B, Q, P>, res: any) => void | Promise<void>;
+export interface RouteSchema {
+    body?: any;
+    query?: any;
+    params?: any;
+    response?: any;
+}
+export interface RouteOptions {
+    schema?: RouteSchema;
+    [key: string]: any;
+}
+export interface FullstxOptions {
+    logger?: boolean;
+    cors?: boolean | object;
+    helmet?: boolean;
+    xss?: boolean;
+    compression?: boolean | object;
+    session?: boolean | object;
+    htmx?: boolean;
+    staticDir?: string;
+    liveReload?: boolean;
+    port?: number;
+    jwtSecret?: string;
+    healthCheck?: boolean;
+    internalPort?: number;
+    internalPortOffset?: number;
+    db?: any;
+    ws?: any;
+    sqlite?: any;
+    sentry?: any;
+}
+export class FullstxApplication {
+    /**
+         * The HTTP Server instance.
+         */
+        server: Server;
+        /**
+         * Database instance (if configured).
+         */
+        db: any;
+        // Routing methods
+        get<B = any, Q = any, P = any>(path: string, options: RouteOptions, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        get<B = any, Q = any, P = any>(path: string, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        post<B = any, Q = any, P = any>(path: string, options: RouteOptions, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        post<B = any, Q = any, P = any>(path: string, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        put<B = any, Q = any, P = any>(path: string, options: RouteOptions, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        put<B = any, Q = any, P = any>(path: string, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        patch<B = any, Q = any, P = any>(path: string, options: RouteOptions, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        patch<B = any, Q = any, P = any>(path: string, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        delete<B = any, Q = any, P = any>(path: string, options: RouteOptions, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        delete<B = any, Q = any, P = any>(path: string, ...handlers: (Middleware<B, Q, P> | RouteHandler<B, Q, P>)[]): this;
+        use(...middlewares: Middleware[]): this;
+        // Lazy loaded middlewares
+        apiKey(key: string): Middleware;
+        basicAuth(credentials: Record<string, string>): Middleware;
+        authorize(roles: string[]): Middleware;
+        requirePermission(permission: string): Middleware;
+        rateLimit(options?: { windowMs?: number; max?: number; message?: string }): Middleware;
+        session(options?: { secret?: string; cookieName?: string; maxAge?: number }): Middleware;
+        csrf(): Middleware;
+        i18n(config?: { defaultLocale?: string; locales?: Record<string, any> }): Middleware;
+        redisCache(redisClient: any, options?: { prefix?: string; expire?: number }): Middleware;
+        csp(options?: Record<string, string | string[]>): Middleware;
+        htmx(): Middleware;
+        routeLocalization(supportedLocales?: string[]): Middleware;
+        // Helpers
+        sanitize(html: string, options?: any): string;
+        metaTags(tags?: Record<string, string>): string;
+        wsBroadcast(data: any): void;
+        factory(count: number, generatorFn: (faker: any, i: number) => any): any[];
+        /**
+         * Registers a plugin.
+         */
+        registerPlugin(plugin: Function | { register: Function }, options?: any): this;
+        /**
+         * Starts the server.
+         */
+        listen(port: number, callback?: () => void): Server;
+    }
+/**
+ * Initializes the Fullstx Framework.
+ * @param options Framework configuration options.
+ */
+export declare function Framework(options?: FullstxOptions): FullstxApplication;
+export default Framework;

package/index.js ADDED Viewed

@@ -0,0 +1,98 @@
+const util = require('util');
+Object.defineProperty(util, '_extend', {
+    value: Object.assign,
+    writable: true,
+    enumerable: true,
+    configurable: true
+});
+require('dotenv').config({ quiet: true });
+const createServer = require('./server');
+const router = require('./router');
+const setupDatabase = require('./lib/database');
+const setupMiddlewares = require('./lib/middlewares');
+const setupWebsocket = require('./lib/websocket');
+const FullstxApplication = require('./lib/application');
+let faker;
+try {
+    faker = require('@faker-js/faker').faker;
+} catch {}
+let sanitizeHtml;
+try {
+    sanitizeHtml = require('sanitize-html');
+} catch {}
+let Sentry;
+try {
+    Sentry = require('@sentry/node');
+} catch {}
+function Framework(options = {}) {
+    const defaults = {
+        logger: true,
+        cors: true,
+        helmet: true,
+        xss: true,
+        compression: true,
+        session: false,
+        htmx: true,
+        staticDir: 'public',
+        liveReload: true,
+        port: 3000,
+        jwtSecret: process.env.JWT_SECRET || 'supersecret',
+        healthCheck: true,
+        internalPort: undefined,
+        db: null,
+        ws: null,
+        sqlite: null,
+        sentry: null
+    };
+    const opts = Object.assign({ ...defaults }, options);
+    if (opts.sentry && Sentry) {
+        Sentry.init(opts.sentry);
+        global.sentryCapture = Sentry.captureException;
+        console.log('[fullstx] Sentry Error Tracking enabled.');
+    }
+    const ws = setupWebsocket(opts, {});
+    const db = setupDatabase(opts, router);
+    setupMiddlewares(opts, router, sanitizeHtml);
+    const server = createServer(router, router.middlewares, {
+        staticDir: opts.staticDir
+    });
+    const app = new FullstxApplication(
+        opts,
+        router,
+        db,
+        ws.wsRedisPub,
+        ws.wsRedisSub,
+        null,
+        Sentry,
+        faker,
+        sanitizeHtml,
+        server
+    );
+    if (ws.wsRedisSub) {
+        const channel = opts.ws.pubSubChannel || 'fullstx_ws_pubsub';
+        ws.wsRedisSub.subscribe(channel, (message) => {
+            if (app.wss) {
+                app.wss.clients.forEach((client) => {
+                    if (client.readyState === 1) client.send(message);
+                });
+            }
+        });
+    }
+    return app;
+}
+module.exports = Framework;