@loadmill/universal 0.3.43 → 0.3.46

package/dist/array-utils.d.ts

@@ -1,6 +1,7 @@
 export declare function deleteOne(arr: any[], index: number): void;
 export declare function swap(arr: any[], oldIndex: number, newIndex: number): void;
-export declare const isNonEmptyArray: (arr: unknown) => boolean;
+export declare const isNonEmptyArray: <T>(arr: T | T[] | undefined) => arr is NonEmptyArray<T>;
+export declare type NonEmptyArray<T> = [T, ...T[]];
 export declare const filterFalsyElements: (arr?: any[]) => any[];
 export declare const filterFalsyElementsByProp: (arr: object[], prop: string) => any[];
 export declare const arrayify: (something: any) => any[];

package/dist/array-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"array-utils.js","sourceRoot":"","sources":["../src/array-utils.ts"],"names":[],"mappings":";;;;;;AAAA,2DAAqC;AACrC,yDAAmC;AAEnC,SAAgB,SAAS,CAAC,GAAU,EAAE,KAAa;IACjD,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;QACd,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KACtB;AACH,CAAC;AAJD,8BAIC;AAED,SAAgB,IAAI,CAAC,GAAU,EAAE,QAAgB,EAAE,QAAgB;IACjE,IAAI,QAAQ,GAAG,QAAQ,EAAE;QACvB,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;KAC7B;SAAM;QACL,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3C,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;KACzB;AACH,CAAC;AARD,oBAQC;AAEM,IAAM,eAAe,GAAG,UAAC,GAAY;IAC1C,OAAA,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;AAApC,CAAoC,CAAC;AAD1B,QAAA,eAAe,mBACW;AAEhC,IAAM,mBAAmB,GAAG,UAAC,GAAe;IAAf,oBAAA,EAAA,QAAe;IACjD,OAAA,GAAG,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,CAAC,EAAH,CAAG,CAAC;AAAtB,CAAsB,CAAC;AADZ,QAAA,mBAAmB,uBACP;AAElB,IAAM,yBAAyB,GAAG,UAAC,GAAa,EAAE,IAAY;IACnE,OAAA,GAAG,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAT,CAAS,CAAC;AAA5B,CAA4B,CAAC;AADlB,QAAA,yBAAyB,6BACP;AAExB,IAAM,QAAQ,GAAG,UAAC,SAAc,IAAK,OAAA,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAlD,CAAkD,CAAC;AAAlF,QAAA,QAAQ,YAA0E;AAE/F,SAAgB,cAAc,CAAC,GAAU,EAAE,GAAG;IAC5C,OAAO,iBAAO,CAAC,gBAAM,CAAC,iBAAO,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAC5C,CAAC;AAFD,wCAEC;AAED;;;;;;;;;;GAUG;AACI,IAAM,8BAA8B,GAAG,UAAC,GAAU,EAAE,MAAW,EAAE,QAAqC;IAArC,yBAAA,EAAA,iBAAqC;IAC3G,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;QACtD,OAAO;KACR;IACD,OAAO,GAAG,CAAC,MAAM,CACf,UAAC,IAAI,EAAE,IAAI;QACT,OAAA,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,CAAC;YACN,IAAI;IAHN,CAGM,CACT,CAAC;AACJ,CAAC,CAAC;AAXW,QAAA,8BAA8B,kCAWzC"}
+{"version":3,"file":"array-utils.js","sourceRoot":"","sources":["../src/array-utils.ts"],"names":[],"mappings":";;;;;;AAAA,2DAAqC;AACrC,yDAAmC;AAEnC,SAAgB,SAAS,CAAC,GAAU,EAAE,KAAa;IACjD,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;QACd,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KACtB;AACH,CAAC;AAJD,8BAIC;AAED,SAAgB,IAAI,CAAC,GAAU,EAAE,QAAgB,EAAE,QAAgB;IACjE,IAAI,QAAQ,GAAG,QAAQ,EAAE;QACvB,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;KAC7B;SAAM;QACL,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3C,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;KACzB;AACH,CAAC;AARD,oBAQC;AAEM,IAAM,eAAe,GAAG,UAAI,GAAwB;IACzD,OAAA,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;AAApC,CAAoC,CAAC;AAD1B,QAAA,eAAe,mBACW;AAIhC,IAAM,mBAAmB,GAAG,UAAC,GAAe;IAAf,oBAAA,EAAA,QAAe;IACjD,OAAA,GAAG,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,CAAC,EAAH,CAAG,CAAC;AAAtB,CAAsB,CAAC;AADZ,QAAA,mBAAmB,uBACP;AAElB,IAAM,yBAAyB,GAAG,UAAC,GAAa,EAAE,IAAY;IACnE,OAAA,GAAG,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAT,CAAS,CAAC;AAA5B,CAA4B,CAAC;AADlB,QAAA,yBAAyB,6BACP;AAExB,IAAM,QAAQ,GAAG,UAAC,SAAc,IAAK,OAAA,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAlD,CAAkD,CAAC;AAAlF,QAAA,QAAQ,YAA0E;AAE/F,SAAgB,cAAc,CAAC,GAAU,EAAE,GAAG;IAC5C,OAAO,iBAAO,CAAC,gBAAM,CAAC,iBAAO,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAC5C,CAAC;AAFD,wCAEC;AAED;;;;;;;;;;GAUG;AACI,IAAM,8BAA8B,GAAG,UAAC,GAAU,EAAE,MAAW,EAAE,QAAqC;IAArC,yBAAA,EAAA,iBAAqC;IAC3G,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;QACtD,OAAO;KACR;IACD,OAAO,GAAG,CAAC,MAAM,CACf,UAAC,IAAI,EAAE,IAAI;QACT,OAAA,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,CAAC;YACN,IAAI;IAHN,CAGM,CACT,CAAC;AACJ,CAAC,CAAC;AAXW,QAAA,8BAA8B,kCAWzC"}

package/dist/typescript-utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * example usage of this function:
+ * arr = [{ id: 1 }, { id: 2 }]
+ * b = { uid: 2 }
+ * const found = ensure(arr.find((a) => a.id === b.uid)); // TS thinks `find` might return undefined.
+ * We know it will never be undefined, so we use `ensure` to tell TS that arg is defined and has value.
+ * @param arg a value which should be defined and initialized
+ * @param msg custom error message
+ * @returns arg if it is defined, otherwise throws TypeError
+ * @throws TypeError if arg is null or undefined
+ */
+export declare function ensure<T>(arg?: T | null, msg?: string): T;
+export declare type AllKeys<T> = T extends unknown ? keyof T : never;
+export declare type Id<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+export declare type _ExclusifyUnion<T, K extends PropertyKey> = T extends unknown ? Id<T & Partial<Record<Exclude<K, keyof T>, never>>> : never;
+export declare type XOR<T> = _ExclusifyUnion<T, AllKeys<T>>;

package/dist/typescript-utils.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensure = void 0;
+/**
+ * example usage of this function:
+ * arr = [{ id: 1 }, { id: 2 }]
+ * b = { uid: 2 }
+ * const found = ensure(arr.find((a) => a.id === b.uid)); // TS thinks `find` might return undefined.
+ * We know it will never be undefined, so we use `ensure` to tell TS that arg is defined and has value.
+ * @param arg a value which should be defined and initialized
+ * @param msg custom error message
+ * @returns arg if it is defined, otherwise throws TypeError
+ * @throws TypeError if arg is null or undefined
+ */
+function ensure(arg, msg) {
+    if (msg === void 0) { msg = 'This value was supposed to be defined'; }
+    if (arg == null) {
+        throw new TypeError(msg);
+    }
+    return arg;
+}
+exports.ensure = ensure;
+//# sourceMappingURL=typescript-utils.js.map

package/dist/typescript-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript-utils.js","sourceRoot":"","sources":["../src/typescript-utils.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACH,SAAgB,MAAM,CAAI,GAAc,EAAE,GAAqD;IAArD,oBAAA,EAAA,6CAAqD;IAC7F,IAAI,GAAG,IAAI,IAAI,EAAE;QACf,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;KAC1B;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAND,wBAMC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loadmill/universal",
-  "version": "0.3.43",
+  "version": "0.3.46",
   "description": "Loadmill universal utilities",
   "main": "dist/",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
     "chalk": "^4.1.0",
     "circular-json": "^0.5.1",
     "country-list": "^2.1.0",
-    "cron-parser": "^2.13.0",
+    "cron-parser": "^4.3.0",
     "cronstrue": "^1.83.0",
     "dayjs": "^1.10.5",
     "log4js": "6.4.0",

package/src/array-utils.ts

@@ -17,9 +17,11 @@ export function swap(arr: any[], oldIndex: number, newIndex: number) {
   }
 }
 
-export const isNonEmptyArray = (arr: unknown): boolean =>
+export const isNonEmptyArray = <T>(arr: T[] | T | undefined): arr is NonEmptyArray<T> =>
   Array.isArray(arr) && arr.length > 0;
 
+export type NonEmptyArray<T> = [T, ...T[]];
+
 export const filterFalsyElements = (arr: any[] = []): any[] =>
   arr.filter((p) => !!p);
 

package/src/typescript-utils.ts

@@ -0,0 +1,27 @@
+/**
+ * example usage of this function:
+ * arr = [{ id: 1 }, { id: 2 }]
+ * b = { uid: 2 }
+ * const found = ensure(arr.find((a) => a.id === b.uid)); // TS thinks `find` might return undefined.
+ * We know it will never be undefined, so we use `ensure` to tell TS that arg is defined and has value.
+ * @param arg a value which should be defined and initialized
+ * @param msg custom error message
+ * @returns arg if it is defined, otherwise throws TypeError
+ * @throws TypeError if arg is null or undefined
+ */
+export function ensure<T>(arg?: T | null, msg: string = 'This value was supposed to be defined'): T {
+  if (arg == null) {
+    throw new TypeError(msg);
+  }
+
+  return arg;
+}
+
+/*
+ * https://giphy.com/gifs/cbs-ghosts-ghostscbs-cbs-zXm8DwxWP2upMOQcQX
+ */
+export type AllKeys<T> = T extends unknown ? keyof T : never;
+export type Id<T> = T extends infer U ? { [K in keyof U]: U[K] } : never;
+export type _ExclusifyUnion<T, K extends PropertyKey> =
+  T extends unknown ? Id<T & Partial<Record<Exclude<K, keyof T>, never>>> : never;
+export type XOR<T> = _ExclusifyUnion<T, AllKeys<T>>; // usage: XOR<Type1, Type2> -> only Type1 or Type2, but no overlap