@ancon/wildcat-utils 1.12.0 → 1.14.0

package/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./shared/enums.js"),r=require("./shared/isWithinFlag.js"),i=require("./shared/generateId.js"),t=require("./outlet/getListOutletOpeningHoursTable.js"),n=require("./versioning/isVersionALessThanB.js"),s=require("./versioning/cleanVersionString.js"),o=require("./api/getUrlAndParams.js"),g=require("./api/getEndpointWithVersion.js"),l=require("./string/slugify.js"),u=require("./color/lighten.js"),a=require("./color/brighten.js"),c=require("./color/darken.js"),d=require("./user/getFullName.js"),q=require("./user/getFullAddressString.js"),_=require("./logger/Logger.js"),p=require("./logger/types.js"),h=require("./printing/isValidPrinter.js"),V=require("./printing/isValidNetworkPrinter.js"),y=require("./printing/isValidStarCloudPrinter.js"),P=require("./printing/getPrinterType.js");require("moment");require("@ancon/wildcat-types");require("compare-versions");require("tinycolor2");require("@ancon/wildcat-printing");exports.DayOfWeek=e.DayOfWeek;exports.IntervalState=e.IntervalState;exports.IntervalType=e.IntervalType;exports.OrderFormat=e.OrderFormat;exports.isWithinFlag=r;exports.generateId=i;exports.getListOutletOpeningHoursTable=t;exports.isVersionALessThanB=n;exports.cleanVersionString=s;exports.getUrlAndParams=o;exports.getEndpointWithVersion=g;exports.slugify=l;exports.lighten=u;exports.brighten=a;exports.darken=c;exports.getFullName=d;exports.getFullAddressString=q;exports.Logger=_;exports.LogLevel=p.LogLevel;exports.isValidPrinter=h;exports.isValidNetworkPrinter=V;exports.isValidStarCloudPrinter=y;exports.getPrinterType=P;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./shared/enums.js"),r=require("./shared/isWithinFlag.js"),i=require("./shared/generateId.js"),t=require("./outlet/getListOutletOpeningHoursTable.js"),n=require("./versioning/isVersionALessThanB.js"),s=require("./versioning/cleanVersionString.js"),o=require("./api/getUrlAndParams.js"),g=require("./api/getEndpointWithVersion.js"),u=require("./string/slugify.js"),a=require("./string/truncate.js"),l=require("./color/lighten.js"),c=require("./color/brighten.js"),d=require("./color/darken.js"),q=require("./user/getFullName.js"),_=require("./user/getFullAddressString.js"),p=require("./logger/Logger.js"),h=require("./logger/types.js"),S=require("./logger/sanitizeAsStringDict.js"),V=require("./printing/isValidPrinter.js"),y=require("./printing/isValidNetworkPrinter.js"),P=require("./printing/isValidStarCloudPrinter.js"),L=require("./printing/getPrinterType.js");require("moment");require("@ancon/wildcat-types");require("compare-versions");require("tinycolor2");require("@ancon/wildcat-printing");exports.DayOfWeek=e.DayOfWeek;exports.IntervalState=e.IntervalState;exports.IntervalType=e.IntervalType;exports.OrderFormat=e.OrderFormat;exports.isWithinFlag=r;exports.generateId=i;exports.getListOutletOpeningHoursTable=t;exports.isVersionALessThanB=n;exports.cleanVersionString=s;exports.getUrlAndParams=o;exports.getEndpointWithVersion=g;exports.slugify=u;exports.truncate=a;exports.lighten=l;exports.brighten=c;exports.darken=d;exports.getFullName=q;exports.getFullAddressString=_;exports.Logger=p;exports.LogLevel=h.LogLevel;exports.sanitizeAsStringDict=S;exports.isValidPrinter=V;exports.isValidNetworkPrinter=y;exports.isValidStarCloudPrinter=P;exports.getPrinterType=L;

package/index.mjs

@@ -3,21 +3,23 @@ import { default as u } from "./shared/isWithinFlag.mjs";
 import { default as x } from "./shared/generateId.mjs";
 import { default as V } from "./outlet/getListOutletOpeningHoursTable.mjs";
 import { default as L } from "./versioning/isVersionALessThanB.mjs";
-import { default as y } from "./versioning/cleanVersionString.mjs";
-import { default as O } from "./api/getUrlAndParams.mjs";
-import { default as T } from "./api/getEndpointWithVersion.mjs";
-import { default as v } from "./string/slugify.mjs";
-import { default as I } from "./color/lighten.mjs";
-import { default as b } from "./color/brighten.mjs";
-import { default as c } from "./color/darken.mjs";
+import { default as S } from "./versioning/cleanVersionString.mjs";
+import { default as A } from "./api/getUrlAndParams.mjs";
+import { default as O } from "./api/getEndpointWithVersion.mjs";
+import { default as c } from "./string/slugify.mjs";
+import { default as v } from "./string/truncate.mjs";
+import { default as W } from "./color/lighten.mjs";
+import { default as D } from "./color/brighten.mjs";
+import { default as w } from "./color/darken.mjs";
 import { default as B } from "./user/getFullName.mjs";
-import { default as D } from "./user/getFullAddressString.mjs";
-import { default as H } from "./logger/Logger.mjs";
-import { LogLevel as j } from "./logger/types.mjs";
-import { default as z } from "./printing/isValidPrinter.mjs";
-import { default as J } from "./printing/isValidNetworkPrinter.mjs";
-import { default as M } from "./printing/isValidStarCloudPrinter.mjs";
-import { default as R } from "./printing/getPrinterType.mjs";
+import { default as E } from "./user/getFullAddressString.mjs";
+import { default as U } from "./logger/Logger.mjs";
+import { LogLevel as q } from "./logger/types.mjs";
+import { default as J } from "./logger/sanitizeAsStringDict.mjs";
+import { default as M } from "./printing/isValidPrinter.mjs";
+import { default as R } from "./printing/isValidNetworkPrinter.mjs";
+import { default as Y } from "./printing/isValidStarCloudPrinter.mjs";
+import { default as _ } from "./printing/getPrinterType.mjs";
 import "moment";
 import "@ancon/wildcat-types";
 import "compare-versions";
@@ -27,24 +29,26 @@ export {
   s as DayOfWeek,
   i as IntervalState,
   d as IntervalType,
-  j as LogLevel,
-  H as Logger,
+  q as LogLevel,
+  U as Logger,
   p as OrderFormat,
-  b as brighten,
-  y as cleanVersionString,
-  c as darken,
+  D as brighten,
+  S as cleanVersionString,
+  w as darken,
   x as generateId,
-  T as getEndpointWithVersion,
-  D as getFullAddressString,
+  O as getEndpointWithVersion,
+  E as getFullAddressString,
   B as getFullName,
   V as getListOutletOpeningHoursTable,
-  R as getPrinterType,
-  O as getUrlAndParams,
-  J as isValidNetworkPrinter,
-  z as isValidPrinter,
-  M as isValidStarCloudPrinter,
+  _ as getPrinterType,
+  A as getUrlAndParams,
+  R as isValidNetworkPrinter,
+  M as isValidPrinter,
+  Y as isValidStarCloudPrinter,
   L as isVersionALessThanB,
   u as isWithinFlag,
-  I as lighten,
-  v as slugify
+  W as lighten,
+  J as sanitizeAsStringDict,
+  c as slugify,
+  v as truncate
 };

package/logger/Logger.d.ts

@@ -1,12 +1,14 @@
-import { LogProperties, LogStrategy } from './types';
-export default class Logger {
+import { LogStrategy } from './types';
+declare class Logger {
     private logStrategy;
     constructor(logStrategy: LogStrategy);
+    private sanitize;
     setLogStrategy(logStrategy: LogStrategy): void;
-    verbose(message: string, properties?: LogProperties): void;
-    debug(message: string, properties?: LogProperties): void;
-    info(message: string, properties?: LogProperties): void;
-    warn(message: string, properties?: LogProperties): void;
-    error(message: string, properties?: LogProperties): void;
-    fatal(message: string, properties?: LogProperties): void;
+    verbose<T = unknown>(message: string, data?: T): void;
+    debug<T = unknown>(message: string, data?: T): void;
+    info<T = unknown>(message: string, data?: T): void;
+    warn<T = unknown>(message: string, data?: T): void;
+    error<T = unknown>(message: string, data?: T): void;
+    fatal<T = unknown>(message: string, data?: T): void;
 }
+export default Logger;

package/logger/Logger.js

@@ -1 +1 @@
-"use strict";const g=require("./types.js");class o{constructor(e){this.logStrategy=e}setLogStrategy(e){this.logStrategy=e}verbose(e,t){this.logStrategy.execute(g.LogLevel.Verbose,e,t)}debug(e,t){this.logStrategy.execute(g.LogLevel.Debug,e,t)}info(e,t){this.logStrategy.execute(g.LogLevel.Information,e,t)}warn(e,t){this.logStrategy.execute(g.LogLevel.Warning,e,t)}error(e,t){this.logStrategy.execute(g.LogLevel.Error,e,t)}fatal(e,t){this.logStrategy.execute(g.LogLevel.Fatal,e,t)}}module.exports=o;
+"use strict";const i=require("./types.js");class s{constructor(e){this.logStrategy=e}sanitize(e){return this.logStrategy.sanitize?this.logStrategy.sanitize(e):e}setLogStrategy(e){this.logStrategy=e}verbose(e,t){this.logStrategy.execute(i.LogLevel.Verbose,e,this.sanitize(t))}debug(e,t){this.logStrategy.execute(i.LogLevel.Debug,e,this.sanitize(t))}info(e,t){this.logStrategy.execute(i.LogLevel.Information,e,this.sanitize(t))}warn(e,t){this.logStrategy.execute(i.LogLevel.Warning,e,this.sanitize(t))}error(e,t){this.logStrategy.execute(i.LogLevel.Error,e,this.sanitize(t))}fatal(e,t){this.logStrategy.execute(i.LogLevel.Fatal,e,this.sanitize(t))}}module.exports=s;

package/logger/Logger.mjs

@@ -1,28 +1,35 @@
-import { LogLevel as r } from "./types.mjs";
+import { LogLevel as i } from "./types.mjs";
 class a {
   constructor(t) {
     this.logStrategy = t;
   }
+  sanitize(t) {
+    return this.logStrategy.sanitize ? this.logStrategy.sanitize(t) : t;
+  }
   setLogStrategy(t) {
     this.logStrategy = t;
   }
   verbose(t, e) {
-    this.logStrategy.execute(r.Verbose, t, e);
+    this.logStrategy.execute(i.Verbose, t, this.sanitize(e));
   }
   debug(t, e) {
-    this.logStrategy.execute(r.Debug, t, e);
+    this.logStrategy.execute(i.Debug, t, this.sanitize(e));
   }
   info(t, e) {
-    this.logStrategy.execute(r.Information, t, e);
+    this.logStrategy.execute(
+      i.Information,
+      t,
+      this.sanitize(e)
+    );
   }
   warn(t, e) {
-    this.logStrategy.execute(r.Warning, t, e);
+    this.logStrategy.execute(i.Warning, t, this.sanitize(e));
   }
   error(t, e) {
-    this.logStrategy.execute(r.Error, t, e);
+    this.logStrategy.execute(i.Error, t, this.sanitize(e));
   }
   fatal(t, e) {
-    this.logStrategy.execute(r.Fatal, t, e);
+    this.logStrategy.execute(i.Fatal, t, this.sanitize(e));
   }
 }
 export {

package/logger/index.d.ts

@@ -1,4 +1,5 @@
 import Logger from './Logger';
-import type { LogProperties, LogStrategy } from './types';
+import type { LogStrategy } from './types';
 import { LogLevel } from './types';
-export { Logger, LogLevel, LogProperties, LogStrategy };
+import sanitizeAsStringDict from './sanitizeAsStringDict';
+export { Logger, LogLevel, LogStrategy, sanitizeAsStringDict };

package/logger/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./Logger.js"),g=require("./types.js");exports.Logger=e;exports.LogLevel=g.LogLevel;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./Logger.js"),r=require("./types.js"),g=require("./sanitizeAsStringDict.js");require("../string/truncate.js");exports.Logger=e;exports.LogLevel=r.LogLevel;exports.sanitizeAsStringDict=g;

package/logger/index.mjs

@@ -1,6 +1,9 @@
-import { default as r } from "./Logger.mjs";
-import { LogLevel as g } from "./types.mjs";
+import { default as t } from "./Logger.mjs";
+import { LogLevel as f } from "./types.mjs";
+import { default as g } from "./sanitizeAsStringDict.mjs";
+import "../string/truncate.mjs";
 export {
-  g as LogLevel,
-  r as Logger
+  f as LogLevel,
+  t as Logger,
+  g as sanitizeAsStringDict
 };

package/logger/sanitizeAsStringDict.d.ts

@@ -0,0 +1,2 @@
+declare function sanitizeAsStringDict<T = unknown>(properties?: T): Record<string, string> | undefined;
+export default sanitizeAsStringDict;

package/logger/sanitizeAsStringDict.js

@@ -0,0 +1 @@
+"use strict";const f=require("../string/truncate.js");function m(n,t){return t?`${t}.${n}`:n}function s(n,t,u){return Object.entries(n).reduce((e,[o,r])=>{const i=m(o,u);return t[i]!==void 0?e:typeof r=="string"?(t[i]=f(r,100),e):typeof r=="number"?(t[i]=f(r.toString(),100),e):typeof r=="object"&&r?s(r,e,o):(t[i]=f(String(r),100),t)},t)}function x(n){if(n)return s(n,{})}module.exports=x;

package/logger/sanitizeAsStringDict.mjs

@@ -0,0 +1,20 @@
+import i from "../string/truncate.mjs";
+function s(n, t) {
+  return t ? `${t}.${n}` : n;
+}
+function u(n, t, m) {
+  return Object.entries(n).reduce(
+    (e, [o, r]) => {
+      const f = s(o, m);
+      return t[f] !== void 0 ? e : typeof r == "string" ? (t[f] = i(r, 100), e) : typeof r == "number" ? (t[f] = i(r.toString(), 100), e) : typeof r == "object" && r ? u(r, e, o) : (t[f] = i(String(r), 100), t);
+    },
+    t
+  );
+}
+function L(n) {
+  if (n)
+    return u(n, {});
+}
+export {
+  L as default
+};

package/logger/types.d.ts

@@ -6,7 +6,16 @@ export declare enum LogLevel {
     Error = 4,
     Fatal = 5
 }
-export declare type LogProperties = Record<string, unknown>;
 export interface LogStrategy {
-    execute: <T extends LogProperties>(logLevel: LogLevel, message: string, properties?: T) => void;
+    /**
+     * Method which should return a sanitized version of `data`.
+     * @param data Additional data from `execute()`
+     */
+    sanitize?(data?: unknown): unknown;
+    /**
+     * @param logLevel `LogLevel`
+     * @param message Message string
+     * @param data Any additional data to log. Sanitized if `sanitize()` method is implemented.
+     */
+    execute(logLevel: LogLevel, message: string, data?: unknown): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ancon/wildcat-utils",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "private": false,
   "main": "index.cjs",
   "module": "index.js",
@@ -56,6 +56,11 @@
       "require": "./logger/index.cjs",
       "types": "./logger/index.d.ts"
     },
+    "./logger/sanitizeAsStringDict": {
+      "import": "./logger/sanitizeAsStringDict.js",
+      "require": "./logger/sanitizeAsStringDict.cjs",
+      "types": "./logger/sanitizeAsStringDict.d.ts"
+    },
     "./logger/types": {
       "import": "./logger/types.js",
       "require": "./logger/types.cjs",
@@ -131,6 +136,11 @@
       "require": "./string/slugify.cjs",
       "types": "./string/slugify.d.ts"
     },
+    "./string/truncate": {
+      "import": "./string/truncate.js",
+      "require": "./string/truncate.cjs",
+      "types": "./string/truncate.d.ts"
+    },
     "./user/getFullAddressString": {
       "import": "./user/getFullAddressString.js",
       "require": "./user/getFullAddressString.cjs",

package/string/index.d.ts

@@ -1,2 +1,3 @@
 import slugify from './slugify';
-export { slugify };
+import truncate from './truncate';
+export { slugify, truncate };

package/string/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./slugify.js");exports.slugify=e;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./slugify.js"),e=require("./truncate.js");exports.slugify=t;exports.truncate=e;

package/string/index.mjs

@@ -1,4 +1,6 @@
 import { default as e } from "./slugify.mjs";
+import { default as r } from "./truncate.mjs";
 export {
-  e as slugify
+  e as slugify,
+  r as truncate
 };

package/string/truncate.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Truncate a string to fit within `maxLen` number of characters.
+ * @param str String to truncate
+ * @param maxLen Max number of characters
+ * @param options Options
+ * @returns Truncated or original string
+ */
+declare function truncate<T = string | undefined | null>(str: T, maxLen: number, options?: {
+    trim?: boolean;
+    ellipsis?: string;
+}): string;
+export default truncate;

package/string/truncate.js

@@ -0,0 +1 @@
+"use strict";function i(u,e,t){const f=(t==null?void 0:t.trim)??!0,l=(t==null?void 0:t.ellipsis)??"...";if(typeof u!="string")return"";let r=u;return e<0||Math.max(0,r.length)>e&&(r=r.substring(0,Math.max(0,e-l.length)),f&&(r=r.trim()),r+=l),r}module.exports=i;

package/string/truncate.mjs

@@ -0,0 +1,10 @@
+function a(l, e, t) {
+  const f = (t == null ? void 0 : t.trim) ?? !0, u = (t == null ? void 0 : t.ellipsis) ?? "...";
+  if (typeof l != "string")
+    return "";
+  let r = l;
+  return e < 0 || Math.max(0, r.length) > e && (r = r.substring(0, Math.max(0, e - u.length)), f && (r = r.trim()), r += u), r;
+}
+export {
+  a as default
+};