@expressots/core 2.5.0 → 2.7.0

package/lib/CHANGELOG.md

@@ -1,5 +1,20 @@
 
 
+## [2.6.0](https://github.com/expressots/expressots/compare/2.5.0...2.6.0) (2023-10-09)
+
+
+### Features
+
+* Added express-session middleware for expressots ([9d0c79f](https://github.com/expressots/expressots/commit/9d0c79f7c4b18cfcac17443c7f76c4384a563471))
+* bump vite from 4.4.10 to 4.4.11 ([45c8a80](https://github.com/expressots/expressots/commit/45c8a804e85875743cc18d95ec5441e19b7df7d3))
+
+
+### Bug Fixes
+
+* Auto setup husky with project setup and installation ([dcdc279](https://github.com/expressots/expressots/commit/dcdc279f9dffe82e739396df763f494c97a3e914))
+* remove prepare husky install from lib ([ba9b536](https://github.com/expressots/expressots/commit/ba9b5363904a7d8981ec49705d5fbf22e20c8dbd))
+* typo ([079aad6](https://github.com/expressots/expressots/commit/079aad6c125fcd100cde5cf98ce84125e7381879))
+
 ## [2.5.0](https://github.com/expressots/expressots/compare/2.4.0...2.5.0) (2023-10-04)
 
 

package/lib/cjs/middleware/interfaces/express-session.interface.js

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

package/lib/cjs/middleware/middleware-resolver.js

@@ -26,6 +26,7 @@ class MiddlewareResolver {
         morgan: "morgan",
         helmet: "helmet",
         rateLimit: "express-rate-limit",
+        session: "express-session",
         // Add other middlewares
     };
     /**

package/lib/cjs/middleware/middleware-service.js

@@ -177,6 +177,22 @@ let Middleware = Middleware_1 = class Middleware {
             });
         }
     }
+    /**
+     * Add a middleware to enable express-session.
+     *
+     * @param options - Optional configuration options for Session.
+     *
+     */
+    addSession(options) {
+        const middleware = (0, middleware_resolver_1.middlewareResolver)("session", options);
+        const middlewareExist = this.middlewareExists("session");
+        if (middleware && !middlewareExist) {
+            this.middlewarePipeline.push({
+                timestamp: new Date(),
+                middleware,
+            });
+        }
+    }
     /**
      * Configures the error handling middleware for the application.
      *

package/lib/cjs/provider/db-in-memory/db-in-memory.provider.js

@@ -0,0 +1,75 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var InMemoryDB_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemoryDB = void 0;
+const decorator_1 = require("../../decorator");
+/**
+ * InMemoryDB Class
+ *
+ * This class and its methods offer functionalities to simulate an in-memory database.
+ * It is particularly useful for developers starting with ExpressoTS without any database connection.
+ *
+ * @decorator @provideSingleton(InMemoryDB)
+ */
+let InMemoryDB = exports.InMemoryDB = InMemoryDB_1 = class InMemoryDB {
+    tables = {};
+    /**
+     * getTable Method
+     *
+     * Retrieves a table by its name from the in-memory database.
+     *
+     * @param tableName - The name of the table to retrieve.
+     * @returns {IEntity[]} - An array of entities.
+     */
+    getTable(tableName) {
+        if (!this.tables[tableName]) {
+            this.tables[tableName] = [];
+        }
+        return this.tables[tableName];
+    }
+    /**
+     * showTables Method
+     *
+     * Prints a list of all tables in the in-memory database to the standard output.
+     */
+    showTables() {
+        if (!this.tables) {
+            process.stdout.write("No tables exist.");
+            return;
+        }
+        process.stdout.write("List of tables:");
+        for (const tableName in this.tables) {
+            process.stdout.write(`\n- ${tableName}`);
+        }
+    }
+    /**
+     * printTable Method
+     *
+     * Prints all records in a specific table to the console.
+     * If the table doesn't exist or is empty, it notifies the user.
+     *
+     * @param tableName - The name of the table to print.
+     */
+    printTable(tableName) {
+        if (!this.tables) {
+            process.stdout.write("No tables exist.");
+            return;
+        }
+        const table = this.getTable(tableName);
+        if (table.length === 0) {
+            process.stdout.write(`Table '${tableName}' is empty.`);
+            return;
+        }
+        process.stdout.write(`\nRecords in table '${tableName}':\n`);
+        console.table(table);
+    }
+};
+exports.InMemoryDB = InMemoryDB = InMemoryDB_1 = __decorate([
+    (0, decorator_1.provideSingleton)(InMemoryDB_1)
+], InMemoryDB);

package/lib/cjs/provider/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidateDTO = exports.Env = exports.Logger = exports.Provider = void 0;
+exports.InMemoryDB = exports.ValidateDTO = exports.Env = exports.Logger = exports.Provider = void 0;
 var provider_service_1 = require("./provider-service");
 Object.defineProperty(exports, "Provider", { enumerable: true, get: function () { return provider_service_1.Provider; } });
 var logger_service_1 = require("./logger/logger-service");
@@ -9,3 +9,5 @@ var env_validator_provider_1 = require("./environment/env-validator.provider");
 Object.defineProperty(exports, "Env", { enumerable: true, get: function () { return env_validator_provider_1.EnvValidatorProvider; } });
 var dto_validator_provider_1 = require("./dto-validator/dto-validator.provider");
 Object.defineProperty(exports, "ValidateDTO", { enumerable: true, get: function () { return dto_validator_provider_1.ValidateDTO; } });
+var db_in_memory_provider_1 = require("./db-in-memory/db-in-memory.provider");
+Object.defineProperty(exports, "InMemoryDB", { enumerable: true, get: function () { return db_in_memory_provider_1.InMemoryDB; } });

package/lib/cjs/types/middleware/index.d.ts

@@ -4,6 +4,7 @@ export { CorsOptions } from "./interfaces/cors.interface";
 export { CompressionOptions } from "./interfaces/compression.interface";
 export { CookieSessionOptions } from "./interfaces/cookie-session/cookie-session.interface";
 export { OptionsHelmet } from "./interfaces/helmet.interface";
+export { SessionOptions } from "./interfaces/express-session.interface";
 export { Keygrip } from "./interfaces/cookie-session/keygrip.interface";
 export { CookieParserOptions } from "./interfaces/cookie-parser.interface";
 export { ServeFaviconOptions } from "./interfaces/serve-favicon.interface";

package/lib/cjs/types/middleware/interfaces/express-session.interface.d.ts

@@ -0,0 +1,208 @@
+/// <reference types="express-serve-static-core" />
+import { Request } from "express";
+interface SessionData {
+    cookie: Cookie;
+}
+interface Cookie extends CookieOptions {
+    /** Returns the original `maxAge` (time-to-live), in milliseconds, of the session cookie. */
+    originalMaxAge: number | null;
+}
+interface Session {
+    id: string;
+    cookie: Cookie;
+    regenerate(callback: (err: any) => void): this;
+    destroy(callback: (err: any) => void): this;
+    reload(callback: (err: any) => void): this;
+    resetMaxAge(): this;
+    save(callback?: (err: any) => void): this;
+    touch(): this;
+}
+interface Store {
+    regenerate(req: Request, callback: (err?: any) => any): void;
+    load(sid: string, callback: (err: any, session?: SessionData) => any): void;
+    createSession(req: Request, session: SessionData): Session & SessionData;
+    get(sid: string, callback: (err: any, session?: SessionData | null) => void): void;
+    set(sid: string, session: SessionData, callback?: (err?: any) => void): void;
+    destroy(sid: string, callback?: (err?: any) => void): void;
+    all?(callback: (err: any, obj?: Array<SessionData> | {
+        [sid: string]: SessionData;
+    } | null) => void): void;
+    length?(callback: (err: any, length?: number) => void): void;
+    clear?(callback?: (err?: any) => void): void;
+    touch?(sid: string, session: SessionData, callback?: () => void): void;
+}
+interface CookieOptions {
+    /**
+     * Specifies the number (in milliseconds) to use when calculating the `Expires Set-Cookie` attribute.
+     * This is done by taking the current server time and adding `maxAge` milliseconds to the value to calculate an `Expires` datetime. By default, no maximum age is set.
+     *
+     * If both `expires` and `maxAge` are set in the options, then the last one defined in the object is what is used.
+     * `maxAge` should be preferred over `expires`.
+     *
+     * @see expires
+     */
+    maxAge?: number | undefined;
+    signed?: boolean | undefined;
+    /**
+     * Specifies the `Date` object to be the value for the `Expires Set-Cookie` attribute.
+     * By default, no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete it on a condition like exiting a web browser application.
+     *
+     * If both `expires` and `maxAge` are set in the options, then the last one defined in the object is what is used.
+     *
+     * @deprecated The `expires` option should not be set directly; instead only use the `maxAge` option
+     * @see maxAge
+     */
+    expires?: Date | null | undefined;
+    /**
+     * Specifies the boolean value for the `HttpOnly Set-Cookie` attribute. When truthy, the `HttpOnly` attribute is set, otherwise it is not.
+     * By default, the `HttpOnly` attribute is set.
+     *
+     * Be careful when setting this to `true`, as compliant clients will not allow client-side JavaScript to see the cookie in `document.cookie`.
+     */
+    httpOnly?: boolean | undefined;
+    /**
+     * Specifies the value for the `Path Set-Cookie` attribute.
+     * By default, this is set to '/', which is the root path of the domain.
+     */
+    path?: string | undefined;
+    /**
+     * Specifies the value for the `Domain Set-Cookie` attribute.
+     * By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.
+     */
+    domain?: string | undefined;
+    /**
+     * Specifies the boolean value for the `Secure Set-Cookie` attribute. When truthy, the `Secure` attribute is set, otherwise it is not. By default, the `Secure` attribute is not set.
+     * Be careful when setting this to true, as compliant clients will not send the cookie back to the server in the future if the browser does not have an HTTPS connection.
+     *
+     * Please note that `secure: true` is a **recommended option**.
+     * However, it requires an https-enabled website, i.e., HTTPS is necessary for secure cookies.
+     * If `secure` is set, and you access your site over HTTP, **the cookie will not be set**.
+     *
+     * The cookie.secure option can also be set to the special value `auto` to have this setting automatically match the determined security of the connection.
+     * Be careful when using this setting if the site is available both as HTTP and HTTPS, as once the cookie is set on HTTPS, it will no longer be visible over HTTP.
+     * This is useful when the Express "trust proxy" setting is properly setup to simplify development vs production configuration.
+     *
+     * If you have your node.js behind a proxy and are using `secure: true`, you need to set "trust proxy" in express. Please see the [README](https://github.com/expressjs/session) for details.
+     *
+     * Please see the [README](https://github.com/expressjs/session) for an example of using secure cookies in production, but allowing for testing in development based on NODE_ENV.
+     */
+    secure?: boolean | "auto" | undefined;
+    encode?: ((val: string) => string) | undefined;
+    /**
+     * Specifies the boolean or string to be the value for the `SameSite Set-Cookie` attribute.
+     * - `true` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
+     * - `false` will not set the `SameSite` attribute.
+     * - `lax` will set the `SameSite` attribute to `Lax` for lax same site enforcement.
+     * - `none` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.
+     * - `strict` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
+     *
+     * More information about the different enforcement levels can be found in the specification.
+     *
+     * **Note:** This is an attribute that has not yet been fully standardized, and may change in the future.
+     * This also means many clients may ignore this attribute until they understand it.
+     */
+    sameSite?: boolean | "lax" | "strict" | "none" | undefined;
+}
+interface SessionOptions {
+    /**
+     * This is the secret used to sign the session cookie. This can be either a string for a single secret, or an array of multiple secrets.
+     * If an array of secrets is provided, **only the first element will be used to sign** the session ID cookie,
+     *   while **all the elements will be considered when verifying the signature** in requests.
+     * The secret itself should be not easily parsed by a human and would best be a random set of characters
+     *
+     * Best practices may include:
+     * - The use of environment variables to store the secret, ensuring the secret itself does not exist in your repository.
+     * - Periodic updates of the secret, while ensuring the previous secret is in the array.
+     *
+     * Using a secret that cannot be guessed will reduce the ability to hijack a session to only guessing the session ID (as determined by the `genid` option).
+     *
+     * Changing the secret value will invalidate all existing sessions.
+     * In order to rotate the secret without invalidating sessions, provide an array of secrets,
+     *   with the new secret as first element of the array, and including previous secrets as the later elements.
+     */
+    secret: string | Array<string>;
+    /**
+     * Function to call to generate a new session ID. Provide a function that returns a string that will be used as a session ID.
+     * The function is given the request as the first argument if you want to use some value attached to it when generating the ID.
+     *
+     * The default value is a function which uses the uid-safe library to generate IDs.
+     * Be careful to generate unique IDs so your sessions do not conflict.
+     */
+    genid?(req: Express.Request): string;
+    /**
+     * The name of the session ID cookie to set in the response (and read from in the request).
+     * The default value is 'connect.sid'.
+     *
+     * Note if you have multiple apps running on the same hostname (this is just the name, i.e. `localhost` or `127.0.0.1`; different schemes and ports do not name a different hostname),
+     *   then you need to separate the session cookies from each other.
+     * The simplest method is to simply set different names per app.
+     */
+    name?: string | undefined;
+    /**
+     * The session store instance, defaults to a new `MemoryStore` instance.
+     * @see MemoryStore
+     */
+    store?: Store | undefined;
+    /**
+     * Settings object for the session ID cookie.
+     * @see CookieOptions
+     */
+    cookie?: CookieOptions | undefined;
+    /**
+     * Force the session identifier cookie to be set on every response. The expiration is reset to the original `maxAge`, resetting the expiration countdown.
+     * The default value is `false`.
+     *
+     * With this enabled, the session identifier cookie will expire in `maxAge` *since the last response was sent* instead of in `maxAge` *since the session was last modified by the server*.
+     * This is typically used in conjuction with short, non-session-length `maxAge` values to provide a quick timeout of the session data
+     *   with reduced potential of it occurring during on going server interactions.
+     *
+     * Note that when this option is set to `true` but the `saveUninitialized` option is set to `false`, the cookie will not be set on a response with an uninitialized session.
+     * This option only modifies the behavior when an existing session was loaded for the request.
+     *
+     * @see saveUninitialized
+     */
+    rolling?: boolean | undefined;
+    /**
+     * Forces the session to be saved back to the session store, even if the session was never modified during the request.
+     * Depending on your store this may be necessary, but it can also create race conditions where a client makes two parallel requests to your server
+     *   and changes made to the session in one request may get overwritten when the other request ends, even if it made no changes (this behavior also depends on what store you're using).
+     *
+     * The default value is `true`, but using the default has been deprecated, as the default will change in the future.
+     * Please research into this setting and choose what is appropriate to your use-case. Typically, you'll want `false`.
+     *
+     * How do I know if this is necessary for my store? The best way to know is to check with your store if it implements the `touch` method.
+     * If it does, then you can safely set `resave: false`.
+     * If it does not implement the `touch` method and your store sets an expiration date on stored sessions, then you likely need `resave: true`.
+     */
+    resave?: boolean | undefined;
+    /**
+     * Trust the reverse proxy when setting secure cookies (via the "X-Forwarded-Proto" header).
+     * The default value is undefined.
+     *
+     * - `true`: The `X-Forwarded-Proto` header will be used.
+     * - `false`: All headers are ignored and the connection is considered secure only if there is a direct TLS/SSL connection.
+     * - `undefined`: Uses the "trust proxy" setting from express
+     */
+    proxy?: boolean | undefined;
+    /**
+     * Forces a session that is "uninitialized" to be saved to the store. A session is uninitialized when it is new but not modified.
+     * Choosing `false` is useful for implementing login sessions, reducing server storage usage, or complying with laws that require permission before setting a cookie.
+     * Choosing `false` will also help with race conditions where a client makes multiple parallel requests without a session.
+     *
+     * The default value is `true`, but using the default has been deprecated, as the default will change in the future.
+     * Please research into this setting and choose what is appropriate to your use-case.
+     *
+     * **If you are using `express-session` in conjunction with PassportJS:**
+     * Passport will add an empty Passport object to the session for use after a user is authenticated, which will be treated as a modification to the session, causing it to be saved.
+     * This has been fixed in PassportJS 0.3.0.
+     */
+    saveUninitialized?: boolean | undefined;
+    /**
+     * Control the result of unsetting req.session (through delete, setting to null, etc.).
+     * - `destroy`: The session will be destroyed (deleted) when the response ends.
+     * - `keep`: The session in the store will be kept, but modifications made during the request are ignored and not saved.
+     * @default 'keep'
+     */
+    unset?: "destroy" | "keep" | undefined;
+}
+export { SessionOptions };

package/lib/cjs/types/middleware/middleware-service.d.ts

@@ -10,6 +10,7 @@ import { ServeFaviconOptions } from "./interfaces/serve-favicon.interface";
 import { FormatFn, OptionsMorgan } from "./interfaces/morgan.interface";
 import { RateLimitOptions } from "./interfaces/express-rate-limit.interface";
 import { OptionsHelmet } from "./interfaces/helmet.interface";
+import { SessionOptions } from "./interfaces/express-session.interface";
 /**
  * ExpressHandler Type
  *
@@ -109,6 +110,13 @@ interface IMiddleware {
      * @param options - Optional configuration options for serving the favicon. Defines the behavior of the favicon middleware like cache control, custom headers, etc.
      */
     addServeFavicon(path: string | Buffer, options?: ServeFaviconOptions): void;
+    /**
+     * Add a middleware to enable express-session.
+     *
+     * @param options - Optional configuration options for Session.
+     *
+     */
+    addSession(options: SessionOptions): void;
     /**
      * Configures the error handling middleware for the application.
      *
@@ -223,6 +231,13 @@ declare class Middleware implements IMiddleware {
      *
      */
     addHelmet(options?: OptionsHelmet): void;
+    /**
+     * Add a middleware to enable express-session.
+     *
+     * @param options - Optional configuration options for Session.
+     *
+     */
+    addSession(options: SessionOptions): void;
     /**
      * Configures the error handling middleware for the application.
      *

package/lib/cjs/types/provider/db-in-memory/db-in-memory.provider.d.ts

@@ -0,0 +1,38 @@
+export interface IInMemoryDBEntity {
+    id: string;
+}
+/**
+ * InMemoryDB Class
+ *
+ * This class and its methods offer functionalities to simulate an in-memory database.
+ * It is particularly useful for developers starting with ExpressoTS without any database connection.
+ *
+ * @decorator @provideSingleton(InMemoryDB)
+ */
+export declare class InMemoryDB {
+    private tables;
+    /**
+     * getTable Method
+     *
+     * Retrieves a table by its name from the in-memory database.
+     *
+     * @param tableName - The name of the table to retrieve.
+     * @returns {IEntity[]} - An array of entities.
+     */
+    getTable(tableName: string): Array<IInMemoryDBEntity>;
+    /**
+     * showTables Method
+     *
+     * Prints a list of all tables in the in-memory database to the standard output.
+     */
+    showTables(): void;
+    /**
+     * printTable Method
+     *
+     * Prints all records in a specific table to the console.
+     * If the table doesn't exist or is empty, it notifies the user.
+     *
+     * @param tableName - The name of the table to print.
+     */
+    printTable(tableName: string): void;
+}

package/lib/cjs/types/provider/index.d.ts

@@ -2,3 +2,4 @@ export { Provider, IProvider } from "./provider-service";
 export { Logger } from "./logger/logger-service";
 export { EnvValidatorProvider as Env } from "./environment/env-validator.provider";
 export { ValidateDTO } from "./dto-validator/dto-validator.provider";
+export { InMemoryDB, IInMemoryDBEntity, } from "./db-in-memory/db-in-memory.provider";

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",
@@ -88,7 +88,7 @@
     "release-it": "^16.1.5",
     "ts-jest": "^29.0.5",
     "typescript": "^5.0.3",
-    "vite": "4.4.10",
+    "vite": "4.4.11",
     "vitest": "0.34.6"
   },
   "release-it": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",
@@ -88,7 +88,7 @@
     "release-it": "^16.1.5",
     "ts-jest": "^29.0.5",
     "typescript": "^5.0.3",
-    "vite": "4.4.10",
+    "vite": "4.4.11",
     "vitest": "0.34.6"
   },
   "release-it": {