@ezez/utils 4.7.1 → 4.8.0

package/src/ignore.spec.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import must from "must";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy";
 import { ignore } from "./ignore";
 import { wait } from "./wait";

package/src/index.ts

@@ -16,6 +16,7 @@ export * from "./ensureError.js";
 export * from "./ensureTimestamp.js";
 export * from "./escapeRegExp.js";
 export * from "./formatDate.js";
+export * from "./formatHash.js";
 export * from "./get.js";
 export * from "./getMultiple.js";
 export * from "./hasProps.js";

package/src/insertSeparator.ts

@@ -5,14 +5,14 @@
  * @param {*} separator - separator to inset
  * @returns {Array} - new array with separator items added or same array if there isn't enough items to put separator
  */
-const insertSeparator = <T, S>(source: T[], separator: S): (T | S)[] => {
+const insertSeparator = <T, S>(source: T[], separator: S): Array<T | S> => {
     if (!Array.isArray(source)) {
         throw new TypeError("Source must be an array");
     }
     if (source.length <= 1) {
         return source;
     }
-    const result: (T | S)[] = [...source];
+    const result: Array<T | S> = [...source];
     for (let i = result.length - 1; i > 0; i--) {
         result.splice(i, 0, separator);
     }

package/src/mapValues.ts

@@ -35,7 +35,7 @@ type MapValuesFn<S, R> = (value: S[keyof S], key: keyof S) => R;
 const mapValues = <SourceObject extends Record<string, unknown>, PossibleReturnValues>(
     source: SourceObject, fn: MapValuesFn<SourceObject, PossibleReturnValues>,
 ): { [P in keyof SourceObject]: PossibleReturnValues } => {
-    const keys = Object.keys(source) as (keyof SourceObject)[];
+    const keys = Object.keys(source) as Array<keyof SourceObject>;
 
     // @ts-expect-error TypeScript doesn't work well with this type with reduce
     // @TODO check with ts 5+ or something

package/src/memoize.spec.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import must from "must";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy";
 import { memoize } from "./memoize";
 

package/src/remove.spec.ts

@@ -1,6 +1,6 @@
 import { remove as _remove } from "lodash";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy.js";
 import { remove } from "./remove.js";
 

package/src/safe.ts

@@ -15,7 +15,7 @@ function safe<T, Y>(fn: () => T, def?: Y): T | (Y extends undefined ? undefined
         return fn();
     }
     catch {
-        // @ts-ignore ts can't do conditional returns in runtime
+        // @ts-expect-error ts can't do conditional returns in runtime
         return def;
     }
 }

package/src/sample.ts

@@ -1,8 +1,8 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 type IsTuple<T> = T extends readonly [infer A, ...(infer B)] ? true : false;
 type MaybeTupleReturn<T> = IsTuple<T> extends true
-    ? (T extends readonly (infer U)[] ? U : never)
-    : (T extends (infer U)[] ? U | undefined : never);
+    ? (T extends ReadonlyArray<infer U> ? U : never)
+    : (T extends Array<infer U> ? U | undefined : never);
 
 /**
  * Picks a random element from an array.

package/src/seq.ts

@@ -15,7 +15,7 @@ type Fn<T> = () => T;
  *
  * @see {@link seq}
  */
-type Functions<T> = Fn<T>[] | [Fn<T>[]];
+type Functions<T> = Array<Fn<T>> | [Array<Fn<T>>];
 
 /**
  * A function that decides if the sequential run should be early stopped.
@@ -25,7 +25,7 @@ type Functions<T> = Fn<T>[] | [Fn<T>[]];
  */
 type EarlyBreaker = (e: unknown) => boolean;
 
-const run = <T>(list: Fn<T>[], earlyBreaker?: EarlyBreaker): Promise<T> => {
+const run = <T>(list: Array<Fn<T>>, earlyBreaker?: EarlyBreaker): Promise<T> => {
     if (!list.length) {
         return fail();
     }
@@ -81,7 +81,7 @@ const seqEarlyBreak = <T>(earlyBreaker: EarlyBreaker | undefined, ...args: Funct
     if (args.length === 1) {
         return run(Array.isArray(args[0]) ? args[0] : [args[0]], earlyBreaker);
     }
-    return run(args as Fn<T>[], earlyBreaker);
+    return run(args as Array<Fn<T>>, earlyBreaker);
 };
 
 /**

package/src/serializeToBuffer/serializeToBuffer.spec.ts

@@ -1,8 +1,10 @@
 import must from "must"; // eslint-disable-line @typescript-eslint/no-shadow
 
 import { serializeToBuffer } from "./serializeToBuffer";
+import { unserializeFromBuffer } from "./unserializeFromBuffer";
 
 const serialize = serializeToBuffer.bind(null, Buffer, []);
+const unserialize = unserializeFromBuffer.bind(null, Buffer, []);
 
 describe("serialize", () => {
     it("serializes basic string", async () => {
@@ -40,4 +42,30 @@ describe("serialize", () => {
         must(serialize(1).toString("hex")).equal("356a00226e3a312200");
     });
     // TODO more tests
+
+    it("serializes-deserializes to the same value", async () => {
+        justString: {
+            const input = "Hello";
+            const serialized = serialize(input);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const [deserialized] = unserialize(serialized);
+            must(deserialized).eql(input);
+        }
+
+        unicodeString: {
+            const input = "Hejżeśświat!";
+            const serialized = serialize(input);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const [deserialized] = unserialize(serialized);
+            must(deserialized).eql(input);
+        }
+
+        emojiString: {
+            const input = "Hello 👋 World 🌍 🎉";
+            const serialized = serialize(input);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const [deserialized] = unserialize(serialized);
+            must(deserialized).eql(input);
+        }
+    });
 });

package/src/serializeToBuffer/serializeToBuffer.ts

@@ -70,7 +70,11 @@ const serializeToBuffer = (
     const dataToSend: Buffer[] = [];
     let totalLength = 0;
     convertedArgs.forEach((arg) => {
-        const len = String(arg.data.length) + arg.mark;
+        // For strings and JSON, we need byte length, not character length
+        const dataByteLength = arg.mark === BINARY_MARK_BIN
+            ? arg.data.length
+            : BufferImplementation.byteLength(arg.data, "utf-8");
+        const len = String(dataByteLength) + arg.mark;
 
         dataToSend.push(BufferImplementation.from(len, "utf-8"));
         dataToSend.push(separator);
@@ -78,7 +82,7 @@ const serializeToBuffer = (
         dataToSend.push(arg.mark === BINARY_MARK_BIN ? arg.data : BufferImplementation.from(arg.data, "utf-8"));
         dataToSend.push(separator);
 
-        totalLength += len.length + separator.length + arg.data.length + separator.length;
+        totalLength += len.length + separator.length + dataByteLength + separator.length;
     });
 
     return BufferImplementation.concat(dataToSend, totalLength);

package/src/setImmutable.ts

@@ -30,7 +30,7 @@ const hasOnlyValidPathParts = (array: unknown[]) => {
  * Path to store value in. Can be a dot-separated string or an array of strings.
  * Numbers are allowed for convenience.
  */
-type Path = number | string | (number | string)[];
+type Path = number | string | Array<number | string>;
 
 const getPathParts = (path: Path) => {
     if (typeof path === "number") {

package/src/sortByMultiple.ts

@@ -30,7 +30,7 @@
 const sortByMultiple = <
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     T extends Record<string | number | symbol, any>,
-    K extends (keyof T)[],
+    K extends Array<keyof T>,
 >(
     propertyNames: K,
     ascending: boolean | Record<K[number], boolean> = true,

package/src/waitFor.spec.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import must from "must";
 
-// @ts-ignore
+// @ts-expect-error Complaining about root dir
 import createSpy from "../test/createSpy";
 import { wait } from "./wait";
 import { waitFor } from "./waitFor";
@@ -91,8 +91,7 @@ describe("waitFor", () => {
 
     it("crashes if check function crashes", async () => {
         await waitFor(() => {
-            // @ts-ignore
-            throw new Error(5);
+            throw new Error("5");
         }, { interval: 40 }).then(() => {
             throw new Error("Should not resolve");
         }, (e: unknown) => {