@expressots/shared 0.1.0 → 0.2.0

package/lib/CHANGELOG.md

@@ -1,8 +1,52 @@
 
 
+## [0.2.0](https://github.com/expressots/shared/compare/0.1.0...0.2.0) (2024-11-16)
+
+
+### Features
+
+* add interfaces for console, middleware, and environment; update index exports ([30d7dbb](https://github.com/expressots/shared/commit/30d7dbb0c24af12e4537f626be816f2f5d8a81a0))
+
+
+### Bug Fixes
+
+* standardize quotes in middleware interface file ([6b3f045](https://github.com/expressots/shared/commit/6b3f0459c3ba0bf58d1de920335c6ef7dd438e32))
+
+
+### Tests
+
+* enhance coverage for configDotenv function and add edge case handling ([58612bd](https://github.com/expressots/shared/commit/58612bd0040b592133bac687cfb29b9c6ece2a94))
+
+## 0.1.0 (2024-11-10)
+
+
+### Features
+
+* add compiler and package definitions ([8352e66](https://github.com/expressots/shared/commit/8352e663c1a3429c70bbf7588380fe92f547e0a9))
+* add early ai unit test generation and code coverage ([7eb5f38](https://github.com/expressots/shared/commit/7eb5f380f6b49ce6316a9749daaa7311fda74f04))
+* add env and compiler modules ([f93f6c3](https://github.com/expressots/shared/commit/f93f6c3a719d1a1129112bee4e5e9cf6e42ddd89))
+* add global config interface ([cbe2e12](https://github.com/expressots/shared/commit/cbe2e127db006273e9049220fe3ed20b964d697b))
+* change to beta version ([4e835ca](https://github.com/expressots/shared/commit/4e835ca58933336bc78d66fb42935bf4d02ec641))
+* update readme to include badges ([5995b1a](https://github.com/expressots/shared/commit/5995b1a3eab1481aa4552ca76683c6b16ae0dc60))
+
+
+### Bug Fixes
+
+* add express config file for testing ([d7ae7e1](https://github.com/expressots/shared/commit/d7ae7e1d91a73965be89a9f96df4dfdbc67575d4))
+* change dependency installation from npm ci to npm install in CI workflow ([6bc1ece](https://github.com/expressots/shared/commit/6bc1ece4da3c9aca717e769a8d2f615058652579))
+* remove compiler load lib ([c8f6085](https://github.com/expressots/shared/commit/c8f6085ffdd2af524522174789cfe51203827bbb))
+* reorder build and test steps in CI workflow; update Jest config to ignore specific paths ([4500863](https://github.com/expressots/shared/commit/45008637af232929c8c20df24c3cf4d6b56a082e))
+* update CI workflow to use npm ci for dependency installation; refine Jest configs ([356c232](https://github.com/expressots/shared/commit/356c232bbfcf6bad7254ee0ab3417fd82f831a9f))
+* update package.json to use exact version numbers for dependencies ([7cdd924](https://github.com/expressots/shared/commit/7cdd924b468af56ccf5bdfaa36b7cad82034e007))
+
+
+### Code Refactoring
+
+* remove unused env property from ExpressoConfig interface ([97663e8](https://github.com/expressots/shared/commit/97663e8a386ece45111eba0c2f8b66d1eb9c90af))
+
 ## 0.0.1 (2023-09-05)
 
 
 ### Bug Fixes
 
-* testing commitlint ([0e78653](https://github.com/expressots/<<repo_name>>/commit/0e786539402f69fdca3fe5b684d850e523db7698))
+* testing commitlint ([0e78653](https://github.com/expressots/<<repo_name>>/commit/0e786539402f69fdca3fe5b684d850e523db7698))

package/lib/cjs/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./config"), exports);
 __exportStar(require("./env"), exports);
+__exportStar(require("./interfaces"), exports);
 __exportStar(require("./utils"), exports);

package/lib/cjs/interfaces/application-express.interface.js

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

package/lib/cjs/interfaces/console.interface.js

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

package/lib/cjs/interfaces/environment.interface.js

@@ -0,0 +1,22 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-namespace */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Env = void 0;
+/**
+ * The Environment namespace contains all the types and interfaces related to environment configuration.
+ * @namespace Environment
+ * @public API
+ */
+var Env;
+(function (Env) {
+    /**
+     * Enum representing possible server environments.
+     * @public API
+     */
+    let ServerEnvironment;
+    (function (ServerEnvironment) {
+        ServerEnvironment["Development"] = "development";
+        ServerEnvironment["Production"] = "production";
+        ServerEnvironment["Remote"] = "remote";
+    })(ServerEnvironment = Env.ServerEnvironment || (Env.ServerEnvironment = {}));
+})(Env || (exports.Env = Env = {}));

package/lib/cjs/interfaces/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Env = exports.RenderEngine = void 0;
+var render_types_1 = require("./render/render.types");
+Object.defineProperty(exports, "RenderEngine", { enumerable: true, get: function () { return render_types_1.RenderEngine; } });
+var environment_interface_1 = require("./environment.interface");
+Object.defineProperty(exports, "Env", { enumerable: true, get: function () { return environment_interface_1.Env; } });

package/lib/cjs/interfaces/middleware.interface.js

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

package/lib/cjs/interfaces/render/ejs.types.js

@@ -0,0 +1,3 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/interfaces/render/render.types.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderEngine = void 0;
+/**
+ * The Render namespace contains all the types and interfaces related to rendering views.
+ * @namespace Render
+ * @public API
+ */
+var RenderEngine;
+(function (RenderEngine) {
+    /**
+     * The supported view engines.
+     * @enum {string} Engine - The supported view engines.
+     * @readonly - This enum is read-only.
+     * @public API
+     */
+    let Engine;
+    (function (Engine) {
+        Engine["HBS"] = "hbs";
+        Engine["EJS"] = "ejs";
+        Engine["PUG"] = "pug";
+    })(Engine = RenderEngine.Engine || (RenderEngine.Engine = {}));
+})(RenderEngine || (exports.RenderEngine = RenderEngine = {}));

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

@@ -1,3 +1,4 @@
 export * from "./config";
 export * from "./env";
+export * from "./interfaces";
 export * from "./utils";

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

@@ -0,0 +1,46 @@
+import express from "express";
+import { Environment, IEnvironment } from "./environment.interface";
+import { IConsoleMessage } from "./console.interface";
+import { RenderEngine } from "./render/render.types";
+/**
+ * Namespace for the Server Application.
+ * @namespace Server
+ * @public API
+ */
+export declare namespace Server {
+    /**
+     * Interface for the WebServer application implementation.
+     */
+    interface IWebServer {
+        initEnvironment(environment: Environment, options?: IEnvironment): void;
+        listen(port: number | string, appInfo?: IConsoleMessage): Promise<void>;
+        setEngine<T extends RenderEngine.EngineOptions>(engine: RenderEngine.Engine, options?: T): Promise<void>;
+    }
+    /**
+     * Constructor type for IWebServer.
+     */
+    interface IWebServerConstructor<T extends IWebServer> {
+        new (): T;
+    }
+    /**
+     * Public Interface for the WebServer application.
+     * @public API
+     */
+    interface IWebServerPublic {
+        /**
+         * Start listening on the given port.
+         * @param port - The port number to listen on.
+         * @param consoleMessage - Optional App info message to display on startup.
+         */
+        listen(port: number | string, consoleMessage?: IConsoleMessage): Promise<void>;
+        /**
+         * Get the underlying HTTP server. (default: Express.js)
+         * @returns The underlying HTTP server after initialization.
+         * @public API
+         */
+        getHttpServer(): Promise<express.Application>;
+    }
+}
+export type IWebServer = Server.IWebServer;
+export type IWebServerConstructor<T extends IWebServer> = Server.IWebServerConstructor<T>;
+export type IWebServerPublic = Server.IWebServerPublic;

package/lib/cjs/types/interfaces/console.interface.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Interface representing application message details for console output.
+ * @public API
+ */
+export interface IConsoleMessage {
+    appName: string;
+    appVersion: string;
+}

package/lib/cjs/types/interfaces/environment.interface.d.ts

@@ -0,0 +1,37 @@
+/**
+ * The Environment namespace contains all the types and interfaces related to environment configuration.
+ * @namespace Environment
+ * @public API
+ */
+export declare namespace Env {
+    /**
+     * Enum representing possible server environments.
+     * @public API
+     */
+    enum ServerEnvironment {
+        Development = "development",
+        Production = "production",
+        Remote = "remote"
+    }
+    /**
+     * Type representing possible server environments.
+     */
+    type TypeServerEnvironment = "development" | "production" | "remote";
+    /**
+     * Interface for environment configuration options.
+     * @public API
+     */
+    interface IEnvironment {
+        env: {
+            development?: string;
+            production?: string;
+        };
+    }
+    /**
+     * Type representing possible server environments.
+     * @public API
+     */
+    type Environment = ServerEnvironment | TypeServerEnvironment | undefined;
+}
+export type Environment = Env.Environment;
+export type IEnvironment = Env.IEnvironment;

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

@@ -0,0 +1,5 @@
+export { RenderEngine } from "./render/render.types";
+export { IConsoleMessage } from "./console.interface";
+export { IExpressoMiddleware } from "./middleware.interface";
+export { Environment, IEnvironment, Env } from "./environment.interface";
+export { IWebServer, IWebServerConstructor, IWebServerPublic, Server, } from "./application-express.interface";

package/lib/cjs/types/interfaces/middleware.interface.d.ts

@@ -0,0 +1,7 @@
+import { Request, Response, NextFunction } from "express";
+/**
+ * ExpressoTS Class middleware interface.
+ */
+export interface IExpressoMiddleware {
+    use(req: Request, res: Response, next: NextFunction): Promise<void> | void;
+}

package/lib/cjs/types/interfaces/render/ejs.types.d.ts

@@ -0,0 +1,169 @@
+/**
+ * An object where {@link filename} is the final parsed path or {@link template} is the content of the included template
+ */
+export type IncluderResult = {
+    filename: string;
+    template?: never;
+} | {
+    template: string;
+    filename?: never;
+};
+/**
+ * @param originalPath the path as it appears in the include statement
+ * @param parsedPath the previously resolved path
+ *
+ * @return An {@link IncluderResult} object containing the filename or template data.
+ */
+type IncluderCallback = (originalPath: string, parsedPath: string) => IncluderResult;
+/**
+ * Escapes a string using HTML/XML escaping rules.
+ *
+ * Returns the empty string for `null` or `undefined`.
+ *
+ * @param markup Input string
+ * @return Escaped string
+ */
+type EscapeCallback = (markup?: any) => string;
+export interface Options {
+    /**
+     * Log the generated JavaScript source for the EJS template to the console.
+     *
+     * @default false
+     */
+    debug?: boolean | undefined;
+    /**
+     * Include additional runtime debugging information in generated template
+     * functions.
+     *
+     * @default true
+     */
+    compileDebug?: boolean | undefined;
+    /**
+     * Whether or not to use `with () {}` construct in the generated template
+     * functions. If set to `false`, data is still accessible through the object
+     * whose name is specified by `ejs.localsName` (defaults to `locals`).
+     *
+     * @default true
+     */
+    _with?: boolean | undefined;
+    /**
+     * Whether to run in strict mode or not.
+     * Enforces `_with=false`.
+     *
+     * @default false
+     */
+    strict?: boolean | undefined;
+    /**
+     * An array of local variables that are always destructured from `localsName`,
+     * available even in strict mode.
+     *
+     * @default []
+     */
+    destructuredLocals?: Array<string> | undefined;
+    /**
+     * Remove all safe-to-remove whitespace, including leading and trailing
+     * whitespace. It also enables a safer version of `-%>` line slurping for all
+     * scriptlet tags (it does not strip new lines of tags in the middle of a
+     * line).
+     *
+     * @default false
+     */
+    rmWhitespace?: boolean | undefined;
+    /**
+     * Whether or not to compile a `ClientFunction` that can be rendered
+     * in the browser without depending on ejs.js. Otherwise, a `TemplateFunction`
+     * will be compiled.
+     *
+     * @default false
+     */
+    client?: boolean | undefined;
+    /**
+     * The escaping function used with `<%=` construct. It is used in rendering
+     * and is `.toString()`ed in the generation of client functions.
+     *
+     * @default ejs.escapeXML
+     */
+    escape?: EscapeCallback | undefined;
+    /**
+     * The filename of the template. Required for inclusion and caching unless
+     * you are using `renderFile`. Also used for error reporting.
+     *
+     * @default undefined
+     */
+    filename?: string | undefined;
+    /**
+     * The path to templates root(s). When this is set, absolute paths for includes
+     * (/filename.ejs) will be relative to the templates root(s).
+     *
+     * @default undefined
+     */
+    root?: Array<string> | string | undefined;
+    /**
+     * The opening delimiter for all statements. This allows you to clearly delinate
+     * the difference between template code and existing delimiters. (It is recommended
+     * to synchronize this with the closeDelimiter property.)
+     *
+     * @default ejs.openDelimiter
+     */
+    openDelimiter?: string | undefined;
+    /**
+     * The closing delimiter for all statements. This allows to to clearly delinate
+     * the difference between template code and existing delimiters. (It is recommended
+     * to synchronize this with the openDelimiter property.)
+     *
+     * @default ejs.closeDelimiter
+     */
+    closeDelimiter?: string | undefined;
+    /**
+     * Character to use with angle brackets for open/close
+     * @default '%'
+     */
+    delimiter?: string | undefined;
+    /**
+     * Whether or not to enable caching of template functions. Beware that
+     * the options of compilation are not checked as being the same, so
+     * special handling is required if, for example, you want to cache client
+     * and regular functions of the same file.
+     *
+     * Requires `filename` to be set. Only works with rendering function.
+     *
+     * @default false
+     */
+    cache?: boolean | undefined;
+    /**
+     * The Object to which `this` is set during rendering.
+     *
+     * @default this
+     */
+    context?: any;
+    /**
+     * Whether or not to create an async function instead of a regular function.
+     * This requires language support.
+     *
+     * @default false
+     */
+    async?: boolean | undefined;
+    /**
+     * Make sure to set this to 'false' in order to skip UglifyJS parsing,
+     * when using ES6 features (`const`, etc) as UglifyJS doesn't understand them.
+     * @default true
+     */
+    beautify?: boolean | undefined;
+    /**
+     * Name to use for the object storing local variables when not using `with` or destructuring.
+     *
+     * @default ejs.localsName
+     */
+    localsName?: string | undefined;
+    /** Set to a string (e.g., 'echo' or 'print') for a function to print output inside scriptlet tags. */
+    outputFunctionName?: string | undefined;
+    /**
+     * An array of paths to use when resolving includes with relative paths
+     */
+    views?: Array<string> | undefined;
+    /**
+     * Custom function to handle EJS includes
+     */
+    includer?: IncluderCallback;
+}
+export {};

package/lib/cjs/types/interfaces/render/render.types.d.ts

@@ -0,0 +1,71 @@
+import { Options } from "./ejs.types";
+/**
+ * The Render namespace contains all the types and interfaces related to rendering views.
+ * @namespace Render
+ * @public API
+ */
+export declare namespace RenderEngine {
+    /**
+     * Ejs options
+     * @typedef {Object} EjsOptions
+     * @property {string | Array<string>} viewsDir - The path to the views folder
+     * @property {string} viewEngine - The view engine
+     * @property {ejs.Options} [serverOptions] - The server options
+     * @public API
+     */
+    type EjsOptions = {
+        viewsDir?: string | Array<string>;
+        viewEngine?: string;
+        serverOptions?: Options;
+    };
+    /**
+     * Handlebars options
+     * @typedef {Object} HandlebarsOptions
+     * @property {string} viewsDir - The path to the views folder
+     * @property {string} viewEngine - The view engine to be used
+     * @property {ConfigOptions} [serverOptions] - The server options
+     * @public API
+     */
+    type HandlebarsOptions = {
+        viewEngine?: string;
+        viewsDir?: string;
+        partialsDir?: string;
+    };
+    /**
+     * Pug options
+     * @typedef {Object} PugOptions
+     * @property {string} viewEngine - The view engine to be used
+     * @property {string} viewsDir - The path to the views folder
+     * @public API
+     */
+    type PugOptions = {
+        viewEngine?: string;
+        viewsDir?: string;
+    };
+    /**
+     * The configuration options for the view engine.
+     * @typedef {HandlebarsOptions | EjsOptions | PugOptions} RenderOptions
+     * @public API
+     */
+    type RenderOptions = {
+        engine: Engine;
+        options?: EngineOptions;
+    };
+    /**
+     * The supported view engines.
+     * @enum {string} Engine - The supported view engines.
+     * @readonly - This enum is read-only.
+     * @public API
+     */
+    enum Engine {
+        HBS = "hbs",
+        EJS = "ejs",
+        PUG = "pug"
+    }
+    /**
+     * The configuration options for the view engine.
+     * @typedef {HandlebarsOptions | EjsOptions} EngineOptions
+     * @public API
+     */
+    type EngineOptions = HandlebarsOptions | EjsOptions | PugOptions;
+}

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/shared",
-  "version": "0.0.1-beta.1",
+  "version": "0.2.0",
   "description": "Shared library for ExpressoTS modules 🐎",
   "author": "Richard Zampieri <richard.zampieri@expresso-ts.com>",
   "main": "./lib/cjs/index.js",
@@ -47,9 +47,6 @@
     "backend",
     "library"
   ],
-  "engines": {
-    "node": ">=18.10.0"
-  },
   "scripts": {
     "prepare": "husky",
     "clean": "node scripts/rm.js lib",
@@ -69,25 +66,25 @@
   },
   "dependencies": {
     "reflect-metadata": "0.2.2",
-    "ts-node": "^10.9.2"
+    "ts-node": "10.9.2"
   },
   "devDependencies": {
     "@commitlint/cli": "19.4.1",
     "@commitlint/config-conventional": "19.2.2",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/express": "4.17.21",
-    "@types/jest": "^29.5.13",
+    "@types/jest": "29.5.13",
     "@types/node": "20.14.10",
     "@typescript-eslint/eslint-plugin": "7.16.1",
     "@typescript-eslint/parser": "7.16.1",
-    "chalk": "^4.1.2",
+    "chalk": "4.1.2",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "husky": "9.1.1",
-    "jest": "^29.7.0",
+    "jest": "29.7.0",
     "prettier": "3.3.3",
     "release-it": "17.6.0",
-    "ts-jest": "^29.2.5",
+    "ts-jest": "29.2.5",
     "typescript": "5.5.3"
   },
   "release-it": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/shared",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Shared library for ExpressoTS modules 🐎",
   "author": "Richard Zampieri <richard.zampieri@expresso-ts.com>",
   "main": "./lib/cjs/index.js",
@@ -47,9 +47,6 @@
     "backend",
     "library"
   ],
-  "engines": {
-    "node": ">=18.10.0"
-  },
   "scripts": {
     "prepare": "husky",
     "clean": "node scripts/rm.js lib",