typeshi 1.2.0 → 1.3.0

package/dist/config/setupLog.d.ts

@@ -2,7 +2,7 @@
  * @file src/config/setupLog.ts
  * @reference https://tslog.js.org/#/?id=pretty-templates-and-styles-color-settings
  */
-import { Logger, ILogObj } from 'tslog';
+import { Logger, ISettingsParam, ILogObj, IPrettyLogStyles } from "tslog";
 /**
  * `TAB = INDENT_LOG_LINE =  '\n\t• '` = newLine + tab + bullet + space
  * - log.debug(s1, INDENT_LOG_LINE + s2, INDENT_LOG_LINE + s3,...)
@@ -12,6 +12,30 @@ export declare const INDENT_LOG_LINE: string;
  * `NL = NEW_LINE =  '\n > '` = newLine + space + > + space
  * */
 export declare const NEW_LINE: string;
+export declare const logTemplates: {
+    /**= {@link timestampTemplate} + {@link logNameTemplate} + {@link logLevelTemplate} + {@link fileInfoTemplate} + `\n\t{{logObjMeta}}` */
+    DEFAULT_LOG_TEMPLATE: string;
+    /** `"{{errorName}}: {{errorMessage}}{INDENT_LOG_LINE}{{errorStack}}"` */
+    DEFAULT_ERROR_TEMPLATE: string;
+    /**`"${fileInfoTemplate}:{{method}} {{stack}}"` */
+    errorStackTemplate: string;
+    /** `"{{yyyy}}-{{mm}}-{{dd}}"` */
+    dateTemplate: string;
+    /** `"{{hh}}:{{MM}}:{{ss}}"` */
+    timeTemplate: string;
+    /** `"{{hh}}:{{MM}}:{{ss}}.{{ms}}"` */
+    msTimeTemplate: string;
+    /** `"(${dateTemplate} ${timeTemplate})"` */
+    timestampTemplate: string;
+    /** `"[{{name}}]"` */
+    logNameTemplate: string;
+    /** `"[{{logLevelName}}]"` */
+    logLevelTemplate: string;
+    /** `"{{filePathWithLine}}"` */
+    fileInfoTemplate: string;
+};
+export declare const PRETTY_LOG_STYLES: IPrettyLogStyles;
+export declare const MAIN_LOGGER_SETTINGS: ISettingsParam<ILogObj>;
 /**
  * `type: "pretty"`
  * @example
@@ -26,5 +50,9 @@ export declare const NEW_LINE: string;
  *
  * */
 export declare const typeshiLogger: Logger<ILogObj>;
+export declare const SIMPLE_LOG_TEMPLATE = " > ";
+/** `type: "pretty"`, `template` = `" > {{logObjMeta}}"` */
+export declare const SIMPLE_LOGGER_SETTINGS: ISettingsParam<ILogObj>;
 export declare const typeshiSimpleLogger: Logger<ILogObj>;
+export declare const HIDDEN_LOGGER_SETTINGS: ISettingsParam<ILogObj>;
 export declare const typeshiHiddenLogger: Logger<ILogObj>;

package/dist/config/setupLog.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.typeshiHiddenLogger = exports.typeshiSimpleLogger = exports.typeshiLogger = exports.NEW_LINE = exports.INDENT_LOG_LINE = void 0;
+exports.typeshiHiddenLogger = exports.HIDDEN_LOGGER_SETTINGS = exports.typeshiSimpleLogger = exports.SIMPLE_LOGGER_SETTINGS = exports.SIMPLE_LOG_TEMPLATE = exports.typeshiLogger = exports.MAIN_LOGGER_SETTINGS = exports.PRETTY_LOG_STYLES = exports.logTemplates = exports.NEW_LINE = exports.INDENT_LOG_LINE = void 0;
 /**
  * @file src/config/setupLog.ts
  * @reference https://tslog.js.org/#/?id=pretty-templates-and-styles-color-settings
@@ -17,6 +17,8 @@ exports.INDENT_LOG_LINE = '\n\t• ';
 exports.NEW_LINE = '\n > ';
 const dateTemplate = "{{yyyy}}-{{mm}}-{{dd}}";
 const timeTemplate = "{{hh}}:{{MM}}:{{ss}}"; //.{{ms}}";
+/** `"{{hh}}:{{MM}}:{{ss}}.{{ms}}"` */
+const msTimeTemplate = `${timeTemplate}.{{ms}}`;
 const timestampTemplate = `(${dateTemplate} ${timeTemplate})`;
 /**not included for now */
 const logNameTemplate = "[{{name}}]"; //"[{{nameWithDelimiterPrefix}}{{name}}{{nameWithDelimiterSuffix}}]";
@@ -29,11 +31,10 @@ const fileInfoTemplate = "{{filePathWithLine}}";
  * use as value for {@link ISettingsParam.prettyLogTemplate}
  * = {@link timestampTemplate} + {@link logNameTemplate} + {@link logLevelTemplate} + {@link fileInfoTemplate} + `\n\t{{logObjMeta}}`
  * - {@link timestampTemplate} = `({{yyyy}}-{{mm}}-{{dd}} {{hh}}:{{MM}}:{{ss}}.{{ms}})`
- * - {@link logNameTemplate} = `"[{{name}}]"`
  * - {@link logLevelTemplate} = `{{logLevelName}}:`
  * - {@link fileInfoTemplate} = `{{fileName}}:{{fileLine}}`
  * */
-const LOG_TEMPLATE = [
+const DEFAULT_LOG_TEMPLATE = [
     logLevelTemplate,
     timestampTemplate,
     // logNameTemplate, 
@@ -47,13 +48,35 @@ const errorInfoTemplate = [
  * use as value for {@link ISettingsParam.prettyErrorTemplate}
  * @description template string for error message.
  * */
-const ERROR_TEMPLATE = `${errorInfoTemplate}`; //`${timestampTemplate} ${logNameTemplate} ${logLevelTemplate} ${fileInfoTemplate}\n${errorInfoTemplate}`;
+const DEFAULT_ERROR_TEMPLATE = `${errorInfoTemplate}`; //`${timestampTemplate} ${logNameTemplate} ${logLevelTemplate} ${fileInfoTemplate}\n${errorInfoTemplate}`;
 /**
  * use as value for {@link ISettingsParam.prettyErrorStackTemplate}.
  * @description template string for error stack trace lines.
  * */
-const ERROR_STACK_TEMPLATE = `${fileInfoTemplate}:{{method}} {{stack}}`;
-const PRETTY_LOG_STYLES = {
+const errorStackTemplate = `${fileInfoTemplate}:{{method}} {{stack}}`;
+exports.logTemplates = {
+    /**= {@link timestampTemplate} + {@link logNameTemplate} + {@link logLevelTemplate} + {@link fileInfoTemplate} + `\n\t{{logObjMeta}}` */
+    DEFAULT_LOG_TEMPLATE,
+    /** `"{{errorName}}: {{errorMessage}}{INDENT_LOG_LINE}{{errorStack}}"` */
+    DEFAULT_ERROR_TEMPLATE,
+    /**`"${fileInfoTemplate}:{{method}} {{stack}}"` */
+    errorStackTemplate,
+    /** `"{{yyyy}}-{{mm}}-{{dd}}"` */
+    dateTemplate,
+    /** `"{{hh}}:{{MM}}:{{ss}}"` */
+    timeTemplate,
+    /** `"{{hh}}:{{MM}}:{{ss}}.{{ms}}"` */
+    msTimeTemplate,
+    /** `"(${dateTemplate} ${timeTemplate})"` */
+    timestampTemplate,
+    /** `"[{{name}}]"` */
+    logNameTemplate,
+    /** `"[{{logLevelName}}]"` */
+    logLevelTemplate,
+    /** `"{{filePathWithLine}}"` */
+    fileInfoTemplate
+};
+exports.PRETTY_LOG_STYLES = {
     yyyy: "green",
     mm: "green",
     dd: "green",
@@ -82,16 +105,16 @@ const PRETTY_LOG_STYLES = {
     errorName: ["red", "bold"],
     errorMessage: "redBright",
 };
-const MAIN_LOGGER_SETTINGS = {
+exports.MAIN_LOGGER_SETTINGS = {
     type: "pretty",
     name: "typeshi_main",
     minLevel: 0,
-    prettyLogTemplate: LOG_TEMPLATE,
-    prettyErrorTemplate: ERROR_TEMPLATE,
-    prettyErrorStackTemplate: ERROR_STACK_TEMPLATE,
+    prettyLogTemplate: DEFAULT_LOG_TEMPLATE,
+    prettyErrorTemplate: DEFAULT_ERROR_TEMPLATE,
+    prettyErrorStackTemplate: errorStackTemplate,
     stylePrettyLogs: true,
     prettyLogTimeZone: "local",
-    prettyLogStyles: PRETTY_LOG_STYLES,
+    prettyLogStyles: exports.PRETTY_LOG_STYLES,
 };
 /**
  * `type: "pretty"`
@@ -106,30 +129,30 @@ const MAIN_LOGGER_SETTINGS = {
  * });
  *
  * */
-exports.typeshiLogger = new tslog_1.Logger(MAIN_LOGGER_SETTINGS);
-const SIMPLE_LOG_TEMPLATE = ` > `;
+exports.typeshiLogger = new tslog_1.Logger(exports.MAIN_LOGGER_SETTINGS);
+exports.SIMPLE_LOG_TEMPLATE = ` > `;
 /** `type: "pretty"`, `template` = `" > {{logObjMeta}}"` */
-const SIMPLE_LOGGER_SETTINGS = {
+exports.SIMPLE_LOGGER_SETTINGS = {
     type: "pretty",
     name: "typeshi_simple",
     minLevel: 0,
-    prettyLogTemplate: SIMPLE_LOG_TEMPLATE,
-    prettyErrorTemplate: ERROR_TEMPLATE,
-    prettyErrorStackTemplate: ERROR_STACK_TEMPLATE,
+    prettyLogTemplate: exports.SIMPLE_LOG_TEMPLATE,
+    prettyErrorTemplate: DEFAULT_ERROR_TEMPLATE,
+    prettyErrorStackTemplate: errorStackTemplate,
     stylePrettyLogs: true,
     prettyLogTimeZone: "local",
-    prettyLogStyles: PRETTY_LOG_STYLES,
+    prettyLogStyles: exports.PRETTY_LOG_STYLES,
 };
-exports.typeshiSimpleLogger = new tslog_1.Logger(SIMPLE_LOGGER_SETTINGS);
-const HIDDEN_LOGGER_SETTINGS = {
+exports.typeshiSimpleLogger = new tslog_1.Logger(exports.SIMPLE_LOGGER_SETTINGS);
+exports.HIDDEN_LOGGER_SETTINGS = {
     type: "hidden",
     name: "typeshi_hidden",
     minLevel: 0,
-    prettyLogTemplate: SIMPLE_LOG_TEMPLATE,
-    prettyErrorTemplate: ERROR_TEMPLATE,
-    prettyErrorStackTemplate: ERROR_STACK_TEMPLATE,
+    prettyLogTemplate: exports.SIMPLE_LOG_TEMPLATE,
+    prettyErrorTemplate: DEFAULT_ERROR_TEMPLATE,
+    prettyErrorStackTemplate: errorStackTemplate,
     stylePrettyLogs: true,
     prettyLogTimeZone: "local",
-    prettyLogStyles: PRETTY_LOG_STYLES,
+    prettyLogStyles: exports.PRETTY_LOG_STYLES,
 };
-exports.typeshiHiddenLogger = new tslog_1.Logger(HIDDEN_LOGGER_SETTINGS);
+exports.typeshiHiddenLogger = new tslog_1.Logger(exports.HIDDEN_LOGGER_SETTINGS);

package/dist/utils/argumentValidation.d.ts

@@ -3,12 +3,15 @@
  * @description moved the content of parameter type checks at the start of
  * functions to here. use these when you want your function to throw a fit when
  * it receives bad input.
+ * @example
+ * import * as validate from "@typeshi/argumentValidation";
  * @TODO add boolean value configurable by a setter function that specifies if errors should be thrown or only logged
  * - maybe add a configurable value that the validation functions should return if the validation test fails
  * - change the validation functions such that they return the validated value, if possible?
  * - or maybe have them return boolean type predicates ?
  * - -> maybe have to make a class
  * - research the thingy where a type is after the function name and before parens
+ * @consideration add a default export named 'validate'
  */
 import { TypeOfEnum } from "./typeValidation";
 /**
@@ -179,7 +182,7 @@ export declare function enumArgument(source: string, label: string, value: any,
  * = `{ [valueLabel: string]: valueToCheck } & ({ isEnumFunction } | { EnumObject })`
  */
 export declare function enumArgument(source: string, labeledArgs: EnumArgumentOptions): string | number;
-/** use existingFileArgument() or existingDirectoryArgument() */
+/** recommend to instead use `existingFileArgument()` or `existingDirectoryArgument()` */
 export declare function existingPathArgument(source: string, arg2: string | {
     [label: string]: any;
 }, value?: any, extension?: string): void;

package/dist/utils/argumentValidation.js

@@ -55,19 +55,21 @@ exports.existingPathArgument = existingPathArgument;
  * @description moved the content of parameter type checks at the start of
  * functions to here. use these when you want your function to throw a fit when
  * it receives bad input.
+ * @example
+ * import * as validate from "@typeshi/argumentValidation";
  * @TODO add boolean value configurable by a setter function that specifies if errors should be thrown or only logged
  * - maybe add a configurable value that the validation functions should return if the validation test fails
  * - change the validation functions such that they return the validated value, if possible?
  * - or maybe have them return boolean type predicates ?
  * - -> maybe have to make a class
  * - research the thingy where a type is after the function name and before parens
+ * @consideration add a default export named 'validate'
  */
 const typeValidation_1 = require("./typeValidation");
 const setupLog_1 = require("../config/setupLog");
 const regex_1 = require("./regex");
 const fs = __importStar(require("fs"));
 const node_path_1 = __importDefault(require("node:path"));
-const typeGuardNamePattern = /(?<=^is).*$/i;
 /**
  * - {@link isNonEmptyString}`(value: any): value is string & { length: number; }`
  * @param source `string` indicating what called `stringArgument()`
@@ -313,6 +315,7 @@ function functionArgument(source, arg2, value) {
         throw new Error(msg);
     }
 }
+const typeGuardNamePattern = /(?<=^is).*$/i;
 /**
  * @note `if` `elementTypeGuard`'s name or its label includes 'Array' then only check `elementTypeGuard(value)`
  * instead of checking `value.every(el => elementTypeGuard(el))`
@@ -497,7 +500,7 @@ allowEmpty) {
         functionLabel = keys.find(k => typeof arg2[k] === 'function');
         let variableLabel = keys.find(k => typeof arg2[k] !== 'function');
         if (!variableLabel) {
-            let msg = [`${source} -> ${vSource} Invalid parameter: arg2 as labeledArgs`,
+            let msg = [`${source} -> ${vSource} Invalid parameter: arg2 as ObjectArgumentOptions`,
                 `Expected: object with labeledObject entry and optional labledTypeGuard entry`,
                 `Received: Object.values(arg2) = ${JSON.stringify(Object.values(arg2))}`
             ].join(setupLog_1.INDENT_LOG_LINE);
@@ -516,7 +519,7 @@ allowEmpty) {
     else {
         let msg = [`${source} -> ${vSource} Invalid parameter: 'arg2'`,
             `Expected: label (string) | labeledArgs (ObjectArgumentOptions | { [label: string]: any | ((value: any) => boolean) })`,
-            `Received: ${typeof arg2} = ${arg2}`
+            `Received: ${typeof arg2} = ${JSON.stringify(arg2)}`
         ].join(setupLog_1.INDENT_LOG_LINE);
         setupLog_1.typeshiLogger.error(msg);
         throw new Error(msg);
@@ -721,7 +724,7 @@ function enumArgument(source, arg2, value, enumLabel, enumObject) {
     }
     return matchedValue;
 }
-/** use existingFileArgument() or existingDirectoryArgument() */
+/** recommend to instead use `existingFileArgument()` or `existingDirectoryArgument()` */
 function existingPathArgument(source, arg2, value, extension) {
     const vSource = getSourceString(__filename, existingPathArgument.name);
     source = (0, exports.bracketed)(source);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "typeshi",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "TypeScript utility modules",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",