@nattyjs/common 0.0.1-beta.1 → 0.0.1-beta.11

package/dist/index.cjs

@@ -4,6 +4,8 @@ const fs = require('fs');
 const dotenv = require('dotenv');
 const dotenvExpand = require('dotenv-expand');
 const path = require('path');
+const child_process = require('child_process');
+const getPortPlease = require('get-port-please');
 
 function _interopNamespaceCompat(e) {
     if (e && typeof e === 'object' && 'default' in e) return e;
@@ -25,6 +27,17 @@ const path__namespace = /*#__PURE__*/_interopNamespaceCompat(path);
 const commonContainer = new class {
   constructor() {
     this.metadataConfig = { services: /* @__PURE__ */ new Map() };
+    this.types = {};
+  }
+  registerType(type) {
+    if (type) {
+      if (typeof type === "string")
+        type = JSON.parse(type);
+      this.types[type.name] = type;
+    }
+  }
+  setupCliConfig(config) {
+    this.nattyCliConfig = config;
   }
   setupConfig(config) {
     const modelBinding = {
@@ -35,7 +48,7 @@ const commonContainer = new class {
         }
       }
     };
-    this.nattyConfig = { ...{ api: { rootPath: "api" }, modelBinding, globalConfig: {} }, ...config };
+    this.nattyConfig = { ...{ api: { rootPath: "api" }, autoGeneratePort: true, modelBinding, globalConfig: {} }, ...config };
   }
   setupBuildOptions(options) {
     this.buildOptions = options;
@@ -43,6 +56,9 @@ const commonContainer = new class {
   setEnvTsDefinition(tsDefinition) {
     this.envTsDefinition = tsDefinition;
   }
+  setEnvValueInfo(valueInfo) {
+    this.envValueInfo = valueInfo;
+  }
   setMetadata(key, value, propName) {
     this.metadataConfig[propName].set(key, value);
   }
@@ -186,6 +202,7 @@ function tsDefinition(value) {
 
 function getEnvTsDefinition(parsed) {
   let serverTypedDefinition = {};
+  let envVariableValueInfo = {};
   if (parsed) {
     const keys = Object.keys(parsed);
     if (keys.length > 0) {
@@ -193,10 +210,11 @@ function getEnvTsDefinition(parsed) {
         let keyName = key;
         const { definition, transformValue } = tsDefinition(parsed[key]);
         serverTypedDefinition[keyName] = definition;
+        envVariableValueInfo[keyName] = parsed[keyName];
       });
     }
   }
-  return serverTypedDefinition;
+  return { parsedEnvTsDefinition: serverTypedDefinition, envVariableValueInfo };
 }
 
 function createPath(pathToCreate) {
@@ -220,18 +238,29 @@ function getPath(pathCollection, isIncludeRoot = true, isCreateFolder = false) {
   return currentPath;
 }
 
+function resolvePath(path$1) {
+  return path.resolve(commonContainer.buildOptions.rootDir, path$1);
+}
+
 async function readEnv() {
-  let filePath = getPath([ENVIRONMENTS, commonContainer.buildOptions.mode && commonContainer.buildOptions.mode !== "dev" ? `.env.${commonContainer.buildOptions.mode}` : `.env`]);
+  const envConfig = commonContainer.nattyCliConfig.env;
+  let filePath = envConfig?.dictionary ? void 0 : getPath([ENVIRONMENTS, commonContainer.buildOptions.mode && commonContainer.buildOptions.mode !== "dev" ? `.env.${commonContainer.buildOptions.mode}` : `.env`]);
+  if (envConfig && envConfig.path)
+    filePath = resolvePath(envConfig.path);
   let parsedEnvTsDefinition = {};
-  if (fs.existsSync(filePath)) {
+  let parsedEnv = commonContainer.nattyCliConfig.env?.dictionary;
+  if (!parsedEnv && filePath && fs.existsSync(filePath)) {
     const { parsed, error } = dotenv__namespace.config({
       debug: !!process.env.DEBUG || void 0,
       path: filePath
     });
-    parsedEnvTsDefinition = getEnvTsDefinition(parsed);
-    commonContainer.setEnvTsDefinition(parsedEnvTsDefinition);
-    dotenvExpand__namespace.expand({ parsed });
+    parsedEnv = parsed;
   }
+  const info = getEnvTsDefinition(parsedEnv);
+  parsedEnvTsDefinition = info.parsedEnvTsDefinition;
+  commonContainer.setEnvTsDefinition(parsedEnvTsDefinition);
+  commonContainer.setEnvValueInfo(info.envVariableValueInfo);
+  dotenvExpand__namespace.expand({ parsed: parsedEnv });
   return parsedEnvTsDefinition;
 }
 
@@ -279,10 +308,10 @@ function readEnvKey(key) {
 }
 
 class UserIdentity {
-  constructor(isAuthenticate, id, claim) {
+  constructor(isAuthenticate, id, claims) {
     this.isAuthenticate = isAuthenticate;
     this.id = id;
-    this.claim = claim;
+    this.claims = claims;
   }
 }
 
@@ -559,7 +588,66 @@ class List {
   }
 }
 
+var FrameworkType = /* @__PURE__ */ ((FrameworkType2) => {
+  FrameworkType2[FrameworkType2["Express"] = 0] = "Express";
+  FrameworkType2[FrameworkType2["Fastify"] = 1] = "Fastify";
+  FrameworkType2[FrameworkType2["AzureFunction"] = 2] = "AzureFunction";
+  FrameworkType2[FrameworkType2["Firebase"] = 3] = "Firebase";
+  FrameworkType2[FrameworkType2["Lambda"] = 4] = "Lambda";
+  return FrameworkType2;
+})(FrameworkType || {});
+
+function registerType(type) {
+  commonContainer.registerType(type);
+}
+
+class AbstractRunner {
+  async exec(command, args, cwd = process.cwd()) {
+    const options = {
+      cwd,
+      stdio: "pipe",
+      shell: true
+    };
+    return new Promise((resolve, reject) => {
+      const child = child_process.spawn(
+        `${command}`,
+        [...args],
+        options
+      );
+      child.stdout.on(
+        "data",
+        (data) => {
+          const writeData = data.toString().replace(/\r\n|\n/, "");
+          if (writeData.indexOf("[NATTYJS]") > -1) {
+            console.log(writeData);
+          }
+        }
+      );
+      child.on("close", (code) => {
+        if (code === 0) {
+          resolve(null);
+        } else {
+          console.error(
+            `${command} ${args}`
+          );
+          reject();
+        }
+      });
+    });
+  }
+}
+
+async function getPort() {
+  const portNumber = commonContainer.nattyConfig?.port || 3200;
+  if (portNumber)
+    return portNumber;
+  const port = await getPortPlease.getPort({ ports: [portNumber, ...Array(50).fill(3001).map((fillValue, index) => fillValue + index)] });
+  commonContainer.nattyConfig.port = port;
+  return port;
+}
+
 exports.ALLOW_METHODS = ALLOW_METHODS;
+exports.AbstractRunner = AbstractRunner;
 exports.ActionFilter = ActionFilter;
 exports.AuthenticationFilter = AuthenticationFilter;
 exports.AuthorizationFilter = AuthorizationFilter;
@@ -571,6 +659,7 @@ exports.DEFAULT_CHILD_PATH = DEFAULT_CHILD_PATH;
 exports.DELETE = DELETE;
 exports.ENVIRONMENTS = ENVIRONMENTS;
 exports.ExceptionFilter = ExceptionFilter;
+exports.FrameworkType = FrameworkType;
 exports.GET = GET;
 exports.HTTP_METHOD_ROUTES = HTTP_METHOD_ROUTES;
 exports.IGNORE_METHODS = IGNORE_METHODS;
@@ -589,10 +678,12 @@ exports.commonContainer = commonContainer;
 exports.createPath = createPath;
 exports.createTestServer = createTestServer;
 exports.getPath = getPath;
+exports.getPort = getPort;
 exports.isConstructor = isConstructor;
 exports.isEqual = isEqual;
 exports.isFunction = isFunction;
 exports.isObject = isObject;
 exports.readEnv = readEnv;
 exports.readEnvKey = readEnvKey;
+exports.registerType = registerType;
 exports.typeContainer = typeContainer;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { RequestRouteInfo, IHttpResult, IModelBindingContext, ProblemDetail, IExceptionContext, HttpResponseInit, NattyTestModule, ModelBinding, BuildOptions, ClassTypeInfo } from '@nattyjs/types';
+import { RequestRouteInfo, IHttpResult, IModelBindingContext, ProblemDetail, IExceptionContext, HttpResponseInit, NattyTestModule, ModelBinding, BuildOptions, TypesInfo, ClassTypeInfo } from '@nattyjs/types';
 
 interface ClassType<T> extends Function {
     new (...args: any[]): T;
@@ -7,8 +7,8 @@ interface ClassType<T> extends Function {
 declare class UserIdentity<T> {
     isAuthenticate: boolean;
     id?: any;
-    claim?: T;
-    constructor(isAuthenticate: boolean, id?: any, claim?: T);
+    claims?: T;
+    constructor(isAuthenticate: boolean, id?: any, claims?: T);
 }
 
 interface IExecutionContext {
@@ -53,6 +53,14 @@ interface GlobalConfig {
     onException?: ClassType<ExceptionFilter>;
 }
 
+interface CorsConfig {
+    origin: string[];
+    methods: string;
+    preflightContinue: boolean;
+    optionsSuccessStatus: number;
+    credentials: boolean;
+}
+
 interface NattyConfig {
     app: any;
     testModule?: NattyTestModule;
@@ -61,22 +69,62 @@ interface NattyConfig {
     };
     modelBinding?: ModelBinding;
     global?: GlobalConfig;
+    autoGeneratePort?: boolean;
+    port?: number;
+    cors?: CorsConfig;
+}
+
+declare abstract class AbstractRunner {
+    abstract run(): void;
+    protected exec(command: string, args: any[], cwd?: string): Promise<null | string>;
+}
+
+interface EnvConfig {
+    path: string;
+    dictionary: {
+        [key: string]: any;
+    };
+}
+
+interface PackageJsonConfig {
+    addExports: string[];
+}
+
+interface LibraryConfig {
+    packageJson: PackageJsonConfig;
+}
+
+interface NattyCliConfig {
+    library?: Partial<LibraryConfig>;
+    env?: Partial<EnvConfig>;
+    runner?: ClassType<AbstractRunner>;
+    port?: number;
 }
 
 declare const commonContainer: {
     setupConfig(config?: NattyConfig): void;
+    setupCliConfig(config: NattyCliConfig): void;
     setupBuildOptions(options: BuildOptions): any;
     get nattyConfig(): NattyConfig;
+    get nattyCliConfig(): NattyCliConfig;
     get buildOptions(): BuildOptions;
     get envTsDefinition(): {
         [key: string]: string;
     };
+    get envValueInfo(): {
+        [key: string]: string;
+    };
     setEnvTsDefinition(tsDefinition: {
         [key: string]: string;
     }): void;
+    setEnvValueInfo(envValueInfo: {
+        [key: string]: string;
+    }): void;
     setMetadata(key: string, value: any, propName: string): void;
     getMetadataValue(key: string, propName: string): any;
     get globalConfig(): GlobalConfig;
+    registerType(type: TypesInfo): void;
+    types: TypesInfo;
 };
 
 declare const typeContainer: {
@@ -200,4 +248,20 @@ declare class List<T> {
 declare function isObject(value: any): boolean;
 declare function isEqual(first: any, second: any): boolean;
 
-export { ALLOW_METHODS, ActionFilter, AuthenticationFilter, AuthorizationFilter, BACK_SLASH_REGEX, BLANK, CONTROLLER, Claim, ClassType, DEFAULT_ACTIONS, DEFAULT_CHILD_PATH, DELETE, ENVIRONMENTS, ExceptionFilter, GET, GlobalConfig, HTTP_METHOD_ROUTES, IActionExecutedContext, IActionExecutingContext, IExecutionContext, IGNORE_METHODS, List, MetaConfigProps, Middleware, NattyConfig, POST, PUT, RIGHT_SLASH, ROUTE_INSTANCES, ROUTE_METHODS, ROUTE_PATHS, TS_EXTENSION, UserIdentity, commonContainer, createPath, createTestServer, getPath, isConstructor, isEqual, isFunction, isObject, readEnv, readEnvKey, typeContainer };
+declare enum FrameworkType {
+    Express = 0,
+    Fastify = 1,
+    AzureFunction = 2,
+    Firebase = 3,
+    Lambda = 4
+}
+
+interface NattyAppConfig extends NattyConfig {
+    framework: FrameworkType;
+}
+
+declare function registerType(type: TypesInfo): void;
+
+declare function getPort(): Promise<number>;
+
+export { ALLOW_METHODS, AbstractRunner, ActionFilter, AuthenticationFilter, AuthorizationFilter, BACK_SLASH_REGEX, BLANK, CONTROLLER, Claim, ClassType, DEFAULT_ACTIONS, DEFAULT_CHILD_PATH, DELETE, ENVIRONMENTS, ExceptionFilter, FrameworkType, GET, GlobalConfig, HTTP_METHOD_ROUTES, IActionExecutedContext, IActionExecutingContext, IExecutionContext, IGNORE_METHODS, List, MetaConfigProps, Middleware, NattyAppConfig, NattyCliConfig, NattyConfig, POST, PUT, RIGHT_SLASH, ROUTE_INSTANCES, ROUTE_METHODS, ROUTE_PATHS, TS_EXTENSION, UserIdentity, commonContainer, createPath, createTestServer, getPath, getPort, isConstructor, isEqual, isFunction, isObject, readEnv, readEnvKey, registerType, typeContainer };

package/dist/index.mjs

@@ -3,10 +3,24 @@ import { existsSync } from 'fs';
 import * as dotenv from 'dotenv';
 import * as dotenvExpand from 'dotenv-expand';
 import * as path from 'path';
+import { resolve } from 'path';
+import { spawn } from 'child_process';
+import { getPort as getPort$1 } from 'get-port-please';
 
 const commonContainer = new class {
   constructor() {
     this.metadataConfig = { services: /* @__PURE__ */ new Map() };
+    this.types = {};
+  }
+  registerType(type) {
+    if (type) {
+      if (typeof type === "string")
+        type = JSON.parse(type);
+      this.types[type.name] = type;
+    }
+  }
+  setupCliConfig(config) {
+    this.nattyCliConfig = config;
   }
   setupConfig(config) {
     const modelBinding = {
@@ -17,7 +31,7 @@ const commonContainer = new class {
         }
       }
     };
-    this.nattyConfig = { ...{ api: { rootPath: "api" }, modelBinding, globalConfig: {} }, ...config };
+    this.nattyConfig = { ...{ api: { rootPath: "api" }, autoGeneratePort: true, modelBinding, globalConfig: {} }, ...config };
   }
   setupBuildOptions(options) {
     this.buildOptions = options;
@@ -25,6 +39,9 @@ const commonContainer = new class {
   setEnvTsDefinition(tsDefinition) {
     this.envTsDefinition = tsDefinition;
   }
+  setEnvValueInfo(valueInfo) {
+    this.envValueInfo = valueInfo;
+  }
   setMetadata(key, value, propName) {
     this.metadataConfig[propName].set(key, value);
   }
@@ -168,6 +185,7 @@ function tsDefinition(value) {
 
 function getEnvTsDefinition(parsed) {
   let serverTypedDefinition = {};
+  let envVariableValueInfo = {};
   if (parsed) {
     const keys = Object.keys(parsed);
     if (keys.length > 0) {
@@ -175,10 +193,11 @@ function getEnvTsDefinition(parsed) {
         let keyName = key;
         const { definition, transformValue } = tsDefinition(parsed[key]);
         serverTypedDefinition[keyName] = definition;
+        envVariableValueInfo[keyName] = parsed[keyName];
       });
     }
   }
-  return serverTypedDefinition;
+  return { parsedEnvTsDefinition: serverTypedDefinition, envVariableValueInfo };
 }
 
 function createPath(pathToCreate) {
@@ -202,18 +221,29 @@ function getPath(pathCollection, isIncludeRoot = true, isCreateFolder = false) {
   return currentPath;
 }
 
+function resolvePath(path) {
+  return resolve(commonContainer.buildOptions.rootDir, path);
+}
+
 async function readEnv() {
-  let filePath = getPath([ENVIRONMENTS, commonContainer.buildOptions.mode && commonContainer.buildOptions.mode !== "dev" ? `.env.${commonContainer.buildOptions.mode}` : `.env`]);
+  const envConfig = commonContainer.nattyCliConfig.env;
+  let filePath = envConfig?.dictionary ? void 0 : getPath([ENVIRONMENTS, commonContainer.buildOptions.mode && commonContainer.buildOptions.mode !== "dev" ? `.env.${commonContainer.buildOptions.mode}` : `.env`]);
+  if (envConfig && envConfig.path)
+    filePath = resolvePath(envConfig.path);
   let parsedEnvTsDefinition = {};
-  if (existsSync(filePath)) {
+  let parsedEnv = commonContainer.nattyCliConfig.env?.dictionary;
+  if (!parsedEnv && filePath && existsSync(filePath)) {
     const { parsed, error } = dotenv.config({
       debug: !!process.env.DEBUG || void 0,
       path: filePath
     });
-    parsedEnvTsDefinition = getEnvTsDefinition(parsed);
-    commonContainer.setEnvTsDefinition(parsedEnvTsDefinition);
-    dotenvExpand.expand({ parsed });
+    parsedEnv = parsed;
   }
+  const info = getEnvTsDefinition(parsedEnv);
+  parsedEnvTsDefinition = info.parsedEnvTsDefinition;
+  commonContainer.setEnvTsDefinition(parsedEnvTsDefinition);
+  commonContainer.setEnvValueInfo(info.envVariableValueInfo);
+  dotenvExpand.expand({ parsed: parsedEnv });
   return parsedEnvTsDefinition;
 }
 
@@ -261,10 +291,10 @@ function readEnvKey(key) {
 }
 
 class UserIdentity {
-  constructor(isAuthenticate, id, claim) {
+  constructor(isAuthenticate, id, claims) {
     this.isAuthenticate = isAuthenticate;
     this.id = id;
-    this.claim = claim;
+    this.claims = claims;
   }
 }
 
@@ -541,4 +571,62 @@ class List {
   }
 }
 
-export { ALLOW_METHODS, ActionFilter, AuthenticationFilter, AuthorizationFilter, BACK_SLASH_REGEX, BLANK, CONTROLLER, DEFAULT_ACTIONS, DEFAULT_CHILD_PATH, DELETE, ENVIRONMENTS, ExceptionFilter, GET, HTTP_METHOD_ROUTES, IGNORE_METHODS, List, MetaConfigProps, Middleware, POST, PUT, RIGHT_SLASH, ROUTE_INSTANCES, ROUTE_METHODS, ROUTE_PATHS, TS_EXTENSION, UserIdentity, commonContainer, createPath, createTestServer, getPath, isConstructor, isEqual, isFunction, isObject, readEnv, readEnvKey, typeContainer };
+var FrameworkType = /* @__PURE__ */ ((FrameworkType2) => {
+  FrameworkType2[FrameworkType2["Express"] = 0] = "Express";
+  FrameworkType2[FrameworkType2["Fastify"] = 1] = "Fastify";
+  FrameworkType2[FrameworkType2["AzureFunction"] = 2] = "AzureFunction";
+  FrameworkType2[FrameworkType2["Firebase"] = 3] = "Firebase";
+  FrameworkType2[FrameworkType2["Lambda"] = 4] = "Lambda";
+  return FrameworkType2;
+})(FrameworkType || {});
+
+function registerType(type) {
+  commonContainer.registerType(type);
+}
+
+class AbstractRunner {
+  async exec(command, args, cwd = process.cwd()) {
+    const options = {
+      cwd,
+      stdio: "pipe",
+      shell: true
+    };
+    return new Promise((resolve, reject) => {
+      const child = spawn(
+        `${command}`,
+        [...args],
+        options
+      );
+      child.stdout.on(
+        "data",
+        (data) => {
+          const writeData = data.toString().replace(/\r\n|\n/, "");
+          if (writeData.indexOf("[NATTYJS]") > -1) {
+            console.log(writeData);
+          }
+        }
+      );
+      child.on("close", (code) => {
+        if (code === 0) {
+          resolve(null);
+        } else {
+          console.error(
+            `${command} ${args}`
+          );
+          reject();
+        }
+      });
+    });
+  }
+}
+
+async function getPort() {
+  const portNumber = commonContainer.nattyConfig?.port || 3200;
+  if (portNumber)
+    return portNumber;
+  const port = await getPort$1({ ports: [portNumber, ...Array(50).fill(3001).map((fillValue, index) => fillValue + index)] });
+  commonContainer.nattyConfig.port = port;
+  return port;
+}
+
+export { ALLOW_METHODS, AbstractRunner, ActionFilter, AuthenticationFilter, AuthorizationFilter, BACK_SLASH_REGEX, BLANK, CONTROLLER, DEFAULT_ACTIONS, DEFAULT_CHILD_PATH, DELETE, ENVIRONMENTS, ExceptionFilter, FrameworkType, GET, HTTP_METHOD_ROUTES, IGNORE_METHODS, List, MetaConfigProps, Middleware, POST, PUT, RIGHT_SLASH, ROUTE_INSTANCES, ROUTE_METHODS, ROUTE_PATHS, TS_EXTENSION, UserIdentity, commonContainer, createPath, createTestServer, getPath, getPort, isConstructor, isEqual, isFunction, isObject, readEnv, readEnvKey, registerType, typeContainer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nattyjs/common",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.11",
   "description": "Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth is in ya face when ya hear the British cannons go / BOOM",
   "keywords": [],
   "author": "ajayojha <ojhaajay@outlook.com>",
@@ -14,10 +14,14 @@
   "scripts": {
     "build": "unbuild"
   },
+  "dependencies": {
+    "dotenv": "16.3.1",
+    "dotenv-expand": "10.0.0",
+    "get-port-please": "3.1.1"
+  },
   "devDependencies": {
     "@types/node": "20.3.1",
-    "@nattyjs/types": "0.0.1-beta.1",
-    "unbuild": "1.2.1",
-    "dotenv-expand": "10.0.0"
+    "@nattyjs/types": "0.0.1-beta.11",
+    "unbuild": "1.2.1"
   }
 }