From 3798103e7b8469daa79cba649642a82c82e87d90 Mon Sep 17 00:00:00 2001 From: addisonbeck Date: Fri, 11 Jul 2025 18:08:12 -0400 Subject: [PATCH] chore: copy (de)serialization helpers and utils to new serialization lib --- .../src/lib/deserialization-helpers.spec.ts | 25 + .../src/lib/deserialization-helpers.ts | 40 + libs/serialization/src/lib/utils.spec.ts | 778 ++++++++++++++++++ libs/serialization/src/lib/utils.ts | 626 ++++++++++++++ 4 files changed, 1469 insertions(+) create mode 100644 libs/serialization/src/lib/deserialization-helpers.spec.ts create mode 100644 libs/serialization/src/lib/deserialization-helpers.ts create mode 100644 libs/serialization/src/lib/utils.spec.ts create mode 100644 libs/serialization/src/lib/utils.ts diff --git a/libs/serialization/src/lib/deserialization-helpers.spec.ts b/libs/serialization/src/lib/deserialization-helpers.spec.ts new file mode 100644 index 00000000000..b1ae447997f --- /dev/null +++ b/libs/serialization/src/lib/deserialization-helpers.spec.ts @@ -0,0 +1,25 @@ +import { record } from "./deserialization-helpers"; + +describe("deserialization helpers", () => { + describe("record", () => { + it("deserializes a record when keys are strings", () => { + const deserializer = record((value: number) => value); + const input = { + a: 1, + b: 2, + }; + const output = deserializer(input); + expect(output).toEqual(input); + }); + + it("deserializes a record when keys are numbers", () => { + const deserializer = record((value: number) => value); + const input = { + 1: 1, + 2: 2, + }; + const output = deserializer(input); + expect(output).toEqual(input); + }); + }); +}); diff --git a/libs/serialization/src/lib/deserialization-helpers.ts b/libs/serialization/src/lib/deserialization-helpers.ts new file mode 100644 index 00000000000..cb7d393a83a --- /dev/null +++ b/libs/serialization/src/lib/deserialization-helpers.ts @@ -0,0 +1,40 @@ +// FIXME: Update this file to be type safe and remove this and next line +// @ts-strict-ignore +import { Jsonify } from "type-fest"; + +/** + * + * @param elementDeserializer + * @returns + */ +export function array( + elementDeserializer: (element: Jsonify) => T, +): (array: Jsonify) => T[] { + return (array) => { + if (array == null) { + return null; + } + + return array.map((element) => elementDeserializer(element)); + }; +} + +/** + * + * @param valueDeserializer + */ +export function record( + valueDeserializer: (value: Jsonify) => T, +): (record: Jsonify>) => Record { + return (jsonValue: Jsonify | null>) => { + if (jsonValue == null) { + return null; + } + + const output: Record = {} as any; + Object.entries(jsonValue).forEach(([key, value]) => { + output[key as TKey] = valueDeserializer(value); + }); + return output; + }; +} diff --git a/libs/serialization/src/lib/utils.spec.ts b/libs/serialization/src/lib/utils.spec.ts new file mode 100644 index 00000000000..818138863fb --- /dev/null +++ b/libs/serialization/src/lib/utils.spec.ts @@ -0,0 +1,778 @@ +import * as path from "path"; + +import { Utils } from "./utils"; + +describe("Utils Service", () => { + describe("isGuid", () => { + it("is false when null", () => { + expect(Utils.isGuid(null)).toBe(false); + }); + + it("is false when undefined", () => { + expect(Utils.isGuid(undefined)).toBe(false); + }); + + it("is false when empty", () => { + expect(Utils.isGuid("")).toBe(false); + }); + + it("is false when not a string", () => { + expect(Utils.isGuid(123 as any)).toBe(false); + }); + + it("is false when not a guid", () => { + expect(Utils.isGuid("not a guid")).toBe(false); + }); + + it("is true when a guid", () => { + // we use a limited guid scope in which all zeroes is invalid + expect(Utils.isGuid("00000000-0000-1000-8000-000000000000")).toBe(true); + }); + }); + + describe("getDomain", () => { + it("should fail for invalid urls", () => { + expect(Utils.getDomain(null)).toBeNull(); + expect(Utils.getDomain(undefined)).toBeNull(); + expect(Utils.getDomain(" ")).toBeNull(); + expect(Utils.getDomain('https://bit!:"_&ward.com')).toBeNull(); + expect(Utils.getDomain("bitwarden")).toBeNull(); + }); + + it("should fail for data urls", () => { + expect(Utils.getDomain("data:image/jpeg;base64,AAA")).toBeNull(); + }); + + it("should fail for about urls", () => { + expect(Utils.getDomain("about")).toBeNull(); + expect(Utils.getDomain("about:")).toBeNull(); + expect(Utils.getDomain("about:blank")).toBeNull(); + }); + + it("should fail for file url", () => { + expect(Utils.getDomain("file:///C://somefolder/form.pdf")).toBeNull(); + }); + + it("should handle urls without protocol", () => { + expect(Utils.getDomain("bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("wrong://bitwarden.com")).toBe("bitwarden.com"); + }); + + it("should handle valid urls", () => { + expect(Utils.getDomain("bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("http://bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("https://bitwarden.com")).toBe("bitwarden.com"); + + expect(Utils.getDomain("www.bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("http://www.bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("https://www.bitwarden.com")).toBe("bitwarden.com"); + + expect(Utils.getDomain("vault.bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("http://vault.bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("https://vault.bitwarden.com")).toBe("bitwarden.com"); + + expect(Utils.getDomain("www.vault.bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("http://www.vault.bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getDomain("https://www.vault.bitwarden.com")).toBe("bitwarden.com"); + + expect( + Utils.getDomain("user:password@bitwarden.com:8080/password/sites?and&query#hash"), + ).toBe("bitwarden.com"); + expect( + Utils.getDomain("http://user:password@bitwarden.com:8080/password/sites?and&query#hash"), + ).toBe("bitwarden.com"); + expect( + Utils.getDomain("https://user:password@bitwarden.com:8080/password/sites?and&query#hash"), + ).toBe("bitwarden.com"); + + expect(Utils.getDomain("bitwarden.unknown")).toBe("bitwarden.unknown"); + expect(Utils.getDomain("http://bitwarden.unknown")).toBe("bitwarden.unknown"); + expect(Utils.getDomain("https://bitwarden.unknown")).toBe("bitwarden.unknown"); + }); + + it("should handle valid urls with an underscore in subdomain", () => { + expect(Utils.getDomain("my_vault.bitwarden.com/")).toBe("bitwarden.com"); + expect(Utils.getDomain("http://my_vault.bitwarden.com/")).toBe("bitwarden.com"); + expect(Utils.getDomain("https://my_vault.bitwarden.com/")).toBe("bitwarden.com"); + }); + + it("should support urls containing umlauts", () => { + expect(Utils.getDomain("bütwarden.com")).toBe("bütwarden.com"); + expect(Utils.getDomain("http://bütwarden.com")).toBe("bütwarden.com"); + expect(Utils.getDomain("https://bütwarden.com")).toBe("bütwarden.com"); + + expect(Utils.getDomain("subdomain.bütwarden.com")).toBe("bütwarden.com"); + expect(Utils.getDomain("http://subdomain.bütwarden.com")).toBe("bütwarden.com"); + expect(Utils.getDomain("https://subdomain.bütwarden.com")).toBe("bütwarden.com"); + }); + + it("should support punycode urls", () => { + expect(Utils.getDomain("xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + expect(Utils.getDomain("xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + expect(Utils.getDomain("xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + + expect(Utils.getDomain("subdomain.xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + expect(Utils.getDomain("http://subdomain.xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + expect(Utils.getDomain("https://subdomain.xn--btwarden-65a.com")).toBe( + "xn--btwarden-65a.com", + ); + }); + + it("should support localhost", () => { + expect(Utils.getDomain("localhost")).toBe("localhost"); + expect(Utils.getDomain("http://localhost")).toBe("localhost"); + expect(Utils.getDomain("https://localhost")).toBe("localhost"); + }); + + it("should support localhost with subdomain", () => { + expect(Utils.getDomain("subdomain.localhost")).toBe("localhost"); + expect(Utils.getDomain("http://subdomain.localhost")).toBe("localhost"); + expect(Utils.getDomain("https://subdomain.localhost")).toBe("localhost"); + }); + + it("should support IPv4", () => { + expect(Utils.getDomain("192.168.1.1")).toBe("192.168.1.1"); + expect(Utils.getDomain("http://192.168.1.1")).toBe("192.168.1.1"); + expect(Utils.getDomain("https://192.168.1.1")).toBe("192.168.1.1"); + }); + + it("should support IPv6", () => { + expect(Utils.getDomain("[2620:fe::fe]")).toBe("2620:fe::fe"); + expect(Utils.getDomain("http://[2620:fe::fe]")).toBe("2620:fe::fe"); + expect(Utils.getDomain("https://[2620:fe::fe]")).toBe("2620:fe::fe"); + }); + + it("should reject invalid hostnames", () => { + expect(Utils.getDomain("https://mywebsite.com$.mywebsite.com")).toBeNull(); + expect(Utils.getDomain("https://mywebsite.com!.mywebsite.com")).toBeNull(); + }); + }); + + describe("getHostname", () => { + it("should fail for invalid urls", () => { + expect(Utils.getHostname(null)).toBeNull(); + expect(Utils.getHostname(undefined)).toBeNull(); + expect(Utils.getHostname(" ")).toBeNull(); + expect(Utils.getHostname('https://bit!:"_&ward.com')).toBeNull(); + }); + + it("should fail for data urls", () => { + expect(Utils.getHostname("data:image/jpeg;base64,AAA")).toBeNull(); + }); + + it("should fail for about urls", () => { + expect(Utils.getHostname("about")).toBe("about"); + expect(Utils.getHostname("about:")).toBeNull(); + expect(Utils.getHostname("about:blank")).toBeNull(); + }); + + it("should fail for file url", () => { + expect(Utils.getHostname("file:///C:/somefolder/form.pdf")).toBeNull(); + }); + + it("should handle valid urls", () => { + expect(Utils.getHostname("bitwarden")).toBe("bitwarden"); + expect(Utils.getHostname("http://bitwarden")).toBe("bitwarden"); + expect(Utils.getHostname("https://bitwarden")).toBe("bitwarden"); + + expect(Utils.getHostname("bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getHostname("http://bitwarden.com")).toBe("bitwarden.com"); + expect(Utils.getHostname("https://bitwarden.com")).toBe("bitwarden.com"); + + expect(Utils.getHostname("www.bitwarden.com")).toBe("www.bitwarden.com"); + expect(Utils.getHostname("http://www.bitwarden.com")).toBe("www.bitwarden.com"); + expect(Utils.getHostname("https://www.bitwarden.com")).toBe("www.bitwarden.com"); + + expect(Utils.getHostname("vault.bitwarden.com")).toBe("vault.bitwarden.com"); + expect(Utils.getHostname("http://vault.bitwarden.com")).toBe("vault.bitwarden.com"); + expect(Utils.getHostname("https://vault.bitwarden.com")).toBe("vault.bitwarden.com"); + + expect(Utils.getHostname("www.vault.bitwarden.com")).toBe("www.vault.bitwarden.com"); + expect(Utils.getHostname("http://www.vault.bitwarden.com")).toBe("www.vault.bitwarden.com"); + expect(Utils.getHostname("https://www.vault.bitwarden.com")).toBe("www.vault.bitwarden.com"); + + expect( + Utils.getHostname("user:password@bitwarden.com:8080/password/sites?and&query#hash"), + ).toBe("bitwarden.com"); + expect( + Utils.getHostname("https://user:password@bitwarden.com:8080/password/sites?and&query#hash"), + ).toBe("bitwarden.com"); + expect(Utils.getHostname("https://bitwarden.unknown")).toBe("bitwarden.unknown"); + }); + + it("should handle valid urls with an underscore in subdomain", () => { + expect(Utils.getHostname("my_vault.bitwarden.com/")).toBe("my_vault.bitwarden.com"); + expect(Utils.getHostname("http://my_vault.bitwarden.com/")).toBe("my_vault.bitwarden.com"); + expect(Utils.getHostname("https://my_vault.bitwarden.com/")).toBe("my_vault.bitwarden.com"); + }); + + it("should support urls containing umlauts", () => { + expect(Utils.getHostname("bütwarden.com")).toBe("bütwarden.com"); + expect(Utils.getHostname("http://bütwarden.com")).toBe("bütwarden.com"); + expect(Utils.getHostname("https://bütwarden.com")).toBe("bütwarden.com"); + + expect(Utils.getHostname("subdomain.bütwarden.com")).toBe("subdomain.bütwarden.com"); + expect(Utils.getHostname("http://subdomain.bütwarden.com")).toBe("subdomain.bütwarden.com"); + expect(Utils.getHostname("https://subdomain.bütwarden.com")).toBe("subdomain.bütwarden.com"); + }); + + it("should support punycode urls", () => { + expect(Utils.getHostname("xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + expect(Utils.getHostname("xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + expect(Utils.getHostname("xn--btwarden-65a.com")).toBe("xn--btwarden-65a.com"); + + expect(Utils.getHostname("subdomain.xn--btwarden-65a.com")).toBe( + "subdomain.xn--btwarden-65a.com", + ); + expect(Utils.getHostname("http://subdomain.xn--btwarden-65a.com")).toBe( + "subdomain.xn--btwarden-65a.com", + ); + expect(Utils.getHostname("https://subdomain.xn--btwarden-65a.com")).toBe( + "subdomain.xn--btwarden-65a.com", + ); + }); + + it("should support localhost", () => { + expect(Utils.getHostname("localhost")).toBe("localhost"); + expect(Utils.getHostname("http://localhost")).toBe("localhost"); + expect(Utils.getHostname("https://localhost")).toBe("localhost"); + }); + + it("should support localhost with subdomain", () => { + expect(Utils.getHostname("subdomain.localhost")).toBe("subdomain.localhost"); + expect(Utils.getHostname("http://subdomain.localhost")).toBe("subdomain.localhost"); + expect(Utils.getHostname("https://subdomain.localhost")).toBe("subdomain.localhost"); + }); + + it("should support IPv4", () => { + expect(Utils.getHostname("192.168.1.1")).toBe("192.168.1.1"); + expect(Utils.getHostname("http://192.168.1.1")).toBe("192.168.1.1"); + expect(Utils.getHostname("https://192.168.1.1")).toBe("192.168.1.1"); + }); + + it("should support IPv6", () => { + expect(Utils.getHostname("[2620:fe::fe]")).toBe("2620:fe::fe"); + expect(Utils.getHostname("http://[2620:fe::fe]")).toBe("2620:fe::fe"); + expect(Utils.getHostname("https://[2620:fe::fe]")).toBe("2620:fe::fe"); + }); + }); + + describe("newGuid", () => { + it("should create a valid guid", () => { + const validGuid = + /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i; + expect(Utils.newGuid()).toMatch(validGuid); + }); + }); + + describe("fromByteStringToArray", () => { + it("should handle null", () => { + expect(Utils.fromByteStringToArray(null)).toEqual(null); + }); + }); + + function runInBothEnvironments(testName: string, testFunc: () => void): void { + const environments = [ + { isNode: true, name: "Node environment" }, + { isNode: false, name: "non-Node environment" }, + ]; + + environments.forEach((env) => { + it(`${testName} in ${env.name}`, () => { + Utils.isNode = env.isNode; + testFunc(); + }); + }); + } + + const asciiHelloWorld = "hello world"; + const asciiHelloWorldArray = [104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]; + const b64HelloWorldString = "aGVsbG8gd29ybGQ="; + + describe("fromBufferToB64(...)", () => { + const originalIsNode = Utils.isNode; + + afterEach(() => { + Utils.isNode = originalIsNode; + }); + + runInBothEnvironments("should convert an ArrayBuffer to a b64 string", () => { + const buffer = new Uint8Array(asciiHelloWorldArray).buffer; + const b64String = Utils.fromBufferToB64(buffer); + expect(b64String).toBe(b64HelloWorldString); + }); + + runInBothEnvironments("should return an empty string for an empty ArrayBuffer", () => { + const buffer = new Uint8Array([]).buffer; + const b64String = Utils.fromBufferToB64(buffer); + expect(b64String).toBe(""); + }); + + runInBothEnvironments("should return null for null input", () => { + const b64String = Utils.fromBufferToB64(null); + expect(b64String).toBeNull(); + }); + }); + + describe("fromB64ToArray(...)", () => { + runInBothEnvironments("should convert a b64 string to an Uint8Array", () => { + const expectedArray = new Uint8Array(asciiHelloWorldArray); + + const resultArray = Utils.fromB64ToArray(b64HelloWorldString); + + expect(resultArray).toEqual(expectedArray); + }); + + runInBothEnvironments("should return null for null input", () => { + const expectedArray = Utils.fromB64ToArray(null); + expect(expectedArray).toBeNull(); + }); + + // Hmmm... this passes in browser but not in node + // as node doesn't throw an error for invalid base64 strings. + // It instead produces a buffer with the bytes that could be decoded + // and ignores the rest after an invalid character. + // https://github.com/nodejs/node/issues/8569 + // This could be mitigated with a regex check before decoding... + // runInBothEnvironments("should throw an error for invalid base64 string", () => { + // const invalidB64String = "invalid base64"; + // expect(() => { + // Utils.fromB64ToArrayBuffer(invalidB64String); + // }).toThrow(); + // }); + }); + + describe("Base64 and ArrayBuffer round trip conversions", () => { + const originalIsNode = Utils.isNode; + + afterEach(() => { + Utils.isNode = originalIsNode; + }); + + runInBothEnvironments( + "should correctly round trip convert from ArrayBuffer to base64 and back", + () => { + // Start with a known ArrayBuffer + const originalArray = new Uint8Array(asciiHelloWorldArray); + const originalBuffer = originalArray.buffer; + + // Convert ArrayBuffer to a base64 string + const b64String = Utils.fromBufferToB64(originalBuffer); + + // Convert that base64 string back to an ArrayBuffer + const roundTrippedBuffer = Utils.fromB64ToArray(b64String).buffer; + const roundTrippedArray = new Uint8Array(roundTrippedBuffer); + + // Compare the original ArrayBuffer with the round-tripped ArrayBuffer + expect(roundTrippedArray).toEqual(originalArray); + }, + ); + + runInBothEnvironments( + "should correctly round trip convert from base64 to ArrayBuffer and back", + () => { + // Convert known base64 string to ArrayBuffer + const bufferFromB64 = Utils.fromB64ToArray(b64HelloWorldString).buffer; + + // Convert the ArrayBuffer back to a base64 string + const roundTrippedB64String = Utils.fromBufferToB64(bufferFromB64); + + // Compare the original base64 string with the round-tripped base64 string + expect(roundTrippedB64String).toBe(b64HelloWorldString); + }, + ); + }); + + describe("fromBufferToHex(...)", () => { + const originalIsNode = Utils.isNode; + + afterEach(() => { + Utils.isNode = originalIsNode; + }); + + /** + * Creates a string that represents a sequence of hexadecimal byte values in ascending order. + * Each byte value corresponds to its position in the sequence. + * + * @param {number} length - The number of bytes to include in the string. + * @return {string} A string of hexadecimal byte values in sequential order. + * + * @example + * // Returns '000102030405060708090a0b0c0d0e0f101112...ff' + * createSequentialHexByteString(256); + */ + function createSequentialHexByteString(length: number) { + let sequentialHexString = ""; + for (let i = 0; i < length; i++) { + // Convert the number to a hex string and pad with leading zeros if necessary + const hexByte = i.toString(16).padStart(2, "0"); + sequentialHexString += hexByte; + } + return sequentialHexString; + } + + runInBothEnvironments("should convert an ArrayBuffer to a hex string", () => { + const buffer = new Uint8Array([0, 1, 10, 16, 255]).buffer; + const hexString = Utils.fromBufferToHex(buffer); + expect(hexString).toBe("00010a10ff"); + }); + + runInBothEnvironments("should handle an empty buffer", () => { + const buffer = new ArrayBuffer(0); + const hexString = Utils.fromBufferToHex(buffer); + expect(hexString).toBe(""); + }); + + runInBothEnvironments( + "should correctly convert a large buffer containing a repeating sequence of all 256 unique byte values to hex", + () => { + const largeBuffer = new Uint8Array(1024).map((_, index) => index % 256).buffer; + const hexString = Utils.fromBufferToHex(largeBuffer); + const expectedHexString = createSequentialHexByteString(256).repeat(4); + expect(hexString).toBe(expectedHexString); + }, + ); + + runInBothEnvironments("should correctly convert a buffer with a single byte to hex", () => { + const singleByteBuffer = new Uint8Array([0xab]).buffer; + const hexString = Utils.fromBufferToHex(singleByteBuffer); + expect(hexString).toBe("ab"); + }); + + runInBothEnvironments( + "should correctly convert a buffer with an odd number of bytes to hex", + () => { + const oddByteBuffer = new Uint8Array([0x01, 0x23, 0x45, 0x67, 0x89]).buffer; + const hexString = Utils.fromBufferToHex(oddByteBuffer); + expect(hexString).toBe("0123456789"); + }, + ); + }); + + describe("hexStringToArrayBuffer(...)", () => { + test("should convert a hex string to an ArrayBuffer correctly", () => { + const hexString = "ff0a1b"; // Arbitrary hex string + const expectedResult = new Uint8Array([255, 10, 27]).buffer; + const result = Utils.hexStringToArrayBuffer(hexString); + expect(new Uint8Array(result)).toEqual(new Uint8Array(expectedResult)); + }); + + test("should throw an error if the hex string length is not even", () => { + const hexString = "abc"; // Odd number of characters + expect(() => { + Utils.hexStringToArrayBuffer(hexString); + }).toThrow("HexString has to be an even length"); + }); + + test("should convert a hex string representing zero to an ArrayBuffer correctly", () => { + const hexString = "00"; + const expectedResult = new Uint8Array([0]).buffer; + const result = Utils.hexStringToArrayBuffer(hexString); + expect(new Uint8Array(result)).toEqual(new Uint8Array(expectedResult)); + }); + + test("should handle an empty hex string", () => { + const hexString = ""; + const expectedResult = new ArrayBuffer(0); + const result = Utils.hexStringToArrayBuffer(hexString); + expect(result).toEqual(expectedResult); + }); + + test("should convert a long hex string to an ArrayBuffer correctly", () => { + const hexString = "0102030405060708090a0b0c0d0e0f"; + const expectedResult = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]) + .buffer; + const result = Utils.hexStringToArrayBuffer(hexString); + expect(new Uint8Array(result)).toEqual(new Uint8Array(expectedResult)); + }); + }); + + describe("ArrayBuffer and Hex string round trip conversions", () => { + runInBothEnvironments( + "should allow round-trip conversion from ArrayBuffer to hex and back", + () => { + const originalBuffer = new Uint8Array([10, 20, 30, 40, 255]).buffer; // arbitrary buffer + const hexString = Utils.fromBufferToHex(originalBuffer); + const roundTripBuffer = Utils.hexStringToArrayBuffer(hexString); + expect(new Uint8Array(roundTripBuffer)).toEqual(new Uint8Array(originalBuffer)); + }, + ); + + runInBothEnvironments( + "should allow round-trip conversion from hex to ArrayBuffer and back", + () => { + const hexString = "0a141e28ff"; // arbitrary hex string + const bufferFromHex = Utils.hexStringToArrayBuffer(hexString); + const roundTripHexString = Utils.fromBufferToHex(bufferFromHex); + expect(roundTripHexString).toBe(hexString); + }, + ); + }); + + describe("mapToRecord", () => { + it("should handle null", () => { + expect(Utils.mapToRecord(null)).toEqual(null); + }); + + it("should handle empty map", () => { + expect(Utils.mapToRecord(new Map())).toEqual({}); + }); + + it("should handle convert a Map to a Record", () => { + const map = new Map([ + ["key1", "value1"], + ["key2", "value2"], + ]); + expect(Utils.mapToRecord(map)).toEqual({ key1: "value1", key2: "value2" }); + }); + + it("should handle convert a Map to a Record with non-string keys", () => { + const map = new Map([ + [1, "value1"], + [2, "value2"], + ]); + const result = Utils.mapToRecord(map); + expect(result).toEqual({ 1: "value1", 2: "value2" }); + expect(Utils.recordToMap(result)).toEqual(map); + }); + + it("should not convert an object if it's not a map", () => { + const obj = { key1: "value1", key2: "value2" }; + expect(Utils.mapToRecord(obj as any)).toEqual(obj); + }); + }); + + describe("recordToMap", () => { + it("should handle null", () => { + expect(Utils.recordToMap(null)).toEqual(null); + }); + + it("should handle empty record", () => { + expect(Utils.recordToMap({})).toEqual(new Map()); + }); + + it("should handle convert a Record to a Map", () => { + const record = { key1: "value1", key2: "value2" }; + expect(Utils.recordToMap(record)).toEqual(new Map(Object.entries(record))); + }); + + it("should handle convert a Record to a Map with non-string keys", () => { + const record = { 1: "value1", 2: "value2" }; + const result = Utils.recordToMap(record); + expect(result).toEqual( + new Map([ + [1, "value1"], + [2, "value2"], + ]), + ); + expect(Utils.mapToRecord(result)).toEqual(record); + }); + + it("should not convert an object if already a map", () => { + const map = new Map([ + ["key1", "value1"], + ["key2", "value2"], + ]); + expect(Utils.recordToMap(map as any)).toEqual(map); + }); + }); + + describe("encodeRFC3986URIComponent", () => { + it("returns input string with expected encoded chars", () => { + expect(Utils.encodeRFC3986URIComponent("test'user@example.com")).toBe( + "test%27user%40example.com", + ); + expect(Utils.encodeRFC3986URIComponent("(test)user@example.com")).toBe( + "%28test%29user%40example.com", + ); + expect(Utils.encodeRFC3986URIComponent("testuser!@example.com")).toBe( + "testuser%21%40example.com", + ); + expect(Utils.encodeRFC3986URIComponent("Test*User@example.com")).toBe( + "Test%2AUser%40example.com", + ); + }); + }); + + describe("normalizePath", () => { + it("removes a single traversal", () => { + expect(Utils.normalizePath("../test")).toBe("test"); + }); + + it("removes deep traversals", () => { + expect(Utils.normalizePath("../../test")).toBe("test"); + }); + + it("removes intermediate traversals", () => { + expect(Utils.normalizePath("test/../test")).toBe("test"); + }); + + it("removes multiple encoded traversals", () => { + expect( + Utils.normalizePath("api/sends/access/..%2f..%2f..%2fapi%2fsends%2faccess%2fsendkey"), + ).toBe(path.normalize("api/sends/access/sendkey")); + }); + }); + + describe("getUrl", () => { + it("assumes a http protocol if no protocol is specified", () => { + const urlString = "www.exampleapp.com.au:4000"; + + const actual = Utils.getUrl(urlString); + + expect(actual.protocol).toBe("http:"); + }); + }); + + describe("daysRemaining", () => { + beforeAll(() => { + const now = new Date(2023, 9, 2, 10); + jest.spyOn(Date, "now").mockReturnValue(now.getTime()); + }); + + afterAll(() => { + jest.restoreAllMocks(); + }); + + it("should return 0 for equal dates", () => { + expect(Utils.daysRemaining(new Date(2023, 9, 2))).toBe(0); + expect(Utils.daysRemaining(new Date(2023, 9, 2, 12))).toBe(0); + }); + + it("should return 0 for dates in the past", () => { + expect(Utils.daysRemaining(new Date(2020, 5, 11))).toBe(0); + expect(Utils.daysRemaining(new Date(2023, 9, 1))).toBe(0); + }); + + it("should handle future dates", () => { + expect(Utils.daysRemaining(new Date(2023, 9, 3, 10))).toBe(1); + expect(Utils.daysRemaining(new Date(2023, 10, 12, 10))).toBe(41); + // leap year + expect(Utils.daysRemaining(new Date(2024, 9, 2, 10))).toBe(366); + }); + }); + + describe("fromBufferToUtf8(...)", () => { + const originalIsNode = Utils.isNode; + + afterEach(() => { + Utils.isNode = originalIsNode; + }); + + runInBothEnvironments("should convert an ArrayBuffer to a utf8 string", () => { + const buffer = new Uint8Array(asciiHelloWorldArray).buffer; + const str = Utils.fromBufferToUtf8(buffer); + expect(str).toBe(asciiHelloWorld); + }); + + runInBothEnvironments("should handle an empty buffer", () => { + const buffer = new ArrayBuffer(0); + const str = Utils.fromBufferToUtf8(buffer); + expect(str).toBe(""); + }); + + runInBothEnvironments("should convert a binary ArrayBuffer to a binary string", () => { + const cases = [ + { + input: [ + 174, 21, 17, 79, 39, 130, 132, 173, 49, 180, 113, 118, 160, 15, 47, 99, 57, 208, 141, + 187, 54, 194, 153, 12, 37, 130, 155, 213, 125, 196, 241, 101, + ], + output: "�O'���1�qv�/c9Ѝ�6™ %���}��e", + }, + { + input: [ + 88, 17, 69, 41, 75, 69, 128, 225, 252, 219, 146, 72, 162, 14, 139, 120, 30, 239, 105, + 229, 14, 131, 174, 119, 61, 88, 108, 135, 60, 88, 120, 145, + ], + output: "XE)KE���ےH��x�i���w=Xl� { + const buffer = new Uint8Array(c.input).buffer; + const str = Utils.fromBufferToUtf8(buffer); + // Match the expected output + expect(str).toBe(c.output); + // Make sure it matches with the Node.js Buffer output + expect(str).toBe(Buffer.from(buffer).toString("utf8")); + }); + }); + }); + + describe("fromUtf8ToB64(...)", () => { + const originalIsNode = Utils.isNode; + + afterEach(() => { + Utils.isNode = originalIsNode; + }); + + runInBothEnvironments("should handle empty string", () => { + const str = Utils.fromUtf8ToB64(""); + expect(str).toBe(""); + }); + + runInBothEnvironments("should convert a normal b64 string", () => { + const str = Utils.fromUtf8ToB64(asciiHelloWorld); + expect(str).toBe(b64HelloWorldString); + }); + + runInBothEnvironments("should convert various special characters", () => { + const cases = [ + { input: "»", output: "wrs=" }, + { input: "¦", output: "wqY=" }, + { input: "£", output: "wqM=" }, + { input: "é", output: "w6k=" }, + { input: "ö", output: "w7Y=" }, + { input: "»»", output: "wrvCuw==" }, + ]; + cases.forEach((c) => { + const utfStr = c.input; + const str = Utils.fromUtf8ToB64(utfStr); + expect(str).toBe(c.output); + }); + }); + }); + + describe("fromB64ToUtf8(...)", () => { + const originalIsNode = Utils.isNode; + + afterEach(() => { + Utils.isNode = originalIsNode; + }); + + runInBothEnvironments("should handle empty string", () => { + const str = Utils.fromB64ToUtf8(""); + expect(str).toBe(""); + }); + + runInBothEnvironments("should convert a normal b64 string", () => { + const str = Utils.fromB64ToUtf8(b64HelloWorldString); + expect(str).toBe(asciiHelloWorld); + }); + + runInBothEnvironments("should handle various special characters", () => { + const cases = [ + { input: "wrs=", output: "»" }, + { input: "wqY=", output: "¦" }, + { input: "wqM=", output: "£" }, + { input: "w6k=", output: "é" }, + { input: "w7Y=", output: "ö" }, + { input: "wrvCuw==", output: "»»" }, + ]; + + cases.forEach((c) => { + const b64Str = c.input; + const str = Utils.fromB64ToUtf8(b64Str); + expect(str).toBe(c.output); + }); + }); + }); +}); diff --git a/libs/serialization/src/lib/utils.ts b/libs/serialization/src/lib/utils.ts new file mode 100644 index 00000000000..8d14746f5fe --- /dev/null +++ b/libs/serialization/src/lib/utils.ts @@ -0,0 +1,626 @@ +// FIXME: Update this file to be type safe and remove this and next line +// @ts-strict-ignore +/* eslint-disable no-useless-escape */ +import * as path from "path"; + +import { Buffer as BufferLib } from "buffer/"; +import { Observable, of, switchMap } from "rxjs"; +import { getHostname, parse } from "tldts"; +import { Merge } from "type-fest"; + +// This import has been flagged as unallowed for this class. It may be involved in a circular dependency loop. + +import { KeyService } from "@bitwarden/key-management"; + +import { EncryptService } from "../../key-management/crypto/abstractions/encrypt.service"; +import { I18nService } from "../abstractions/i18n.service"; + +// FIXME: Remove when updating file. Eslint update +// eslint-disable-next-line @typescript-eslint/no-require-imports +const nodeURL = typeof self === "undefined" ? require("url") : null; + +declare global { + /* eslint-disable-next-line no-var */ + var bitwardenContainerService: BitwardenContainerService; +} + +interface BitwardenContainerService { + getKeyService: () => KeyService; + getEncryptService: () => EncryptService; +} + +export class Utils { + static inited = false; + static isNode = false; + static isBrowser = true; + static isMobileBrowser = false; + static isAppleMobileBrowser = false; + static global: typeof global = null; + // Transpiled version of /\p{Emoji_Presentation}/gu using https://mothereff.in/regexpu. Used for compatability in older browsers. + static regexpEmojiPresentation = + /(?:[\u231A\u231B\u23E9-\u23EC\u23F0\u23F3\u25FD\u25FE\u2614\u2615\u2648-\u2653\u267F\u2693\u26A1\u26AA\u26AB\u26BD\u26BE\u26C4\u26C5\u26CE\u26D4\u26EA\u26F2\u26F3\u26F5\u26FA\u26FD\u2705\u270A\u270B\u2728\u274C\u274E\u2753-\u2755\u2757\u2795-\u2797\u27B0\u27BF\u2B1B\u2B1C\u2B50\u2B55]|\uD83C[\uDC04\uDCCF\uDD8E\uDD91-\uDD9A\uDDE6-\uDDFF\uDE01\uDE1A\uDE2F\uDE32-\uDE36\uDE38-\uDE3A\uDE50\uDE51\uDF00-\uDF20\uDF2D-\uDF35\uDF37-\uDF7C\uDF7E-\uDF93\uDFA0-\uDFCA\uDFCF-\uDFD3\uDFE0-\uDFF0\uDFF4\uDFF8-\uDFFF]|\uD83D[\uDC00-\uDC3E\uDC40\uDC42-\uDCFC\uDCFF-\uDD3D\uDD4B-\uDD4E\uDD50-\uDD67\uDD7A\uDD95\uDD96\uDDA4\uDDFB-\uDE4F\uDE80-\uDEC5\uDECC\uDED0-\uDED2\uDED5-\uDED7\uDEEB\uDEEC\uDEF4-\uDEFC\uDFE0-\uDFEB]|\uD83E[\uDD0C-\uDD3A\uDD3C-\uDD45\uDD47-\uDD78\uDD7A-\uDDCB\uDDCD-\uDDFF\uDE70-\uDE74\uDE78-\uDE7A\uDE80-\uDE86\uDE90-\uDEA8\uDEB0-\uDEB6\uDEC0-\uDEC2\uDED0-\uDED6])/g; + static readonly validHosts: string[] = ["localhost"]; + static readonly originalMinimumPasswordLength = 8; + static readonly minimumPasswordLength = 12; + static readonly DomainMatchBlacklist = new Map>([ + ["google.com", new Set(["script.google.com"])], + ]); + + static init() { + if (Utils.inited) { + return; + } + + Utils.inited = true; + Utils.isNode = + typeof process !== "undefined" && + (process as any).release != null && + (process as any).release.name === "node"; + Utils.isBrowser = typeof window !== "undefined"; + + Utils.isMobileBrowser = Utils.isBrowser && this.isMobile(window); + Utils.isAppleMobileBrowser = Utils.isBrowser && this.isAppleMobile(window); + + if (Utils.isNode) { + Utils.global = global; + } else if (Utils.isBrowser) { + Utils.global = window; + } else { + // If it's not browser or node then it must be a service worker + Utils.global = self; + } + } + + static fromB64ToArray(str: string): Uint8Array { + if (str == null) { + return null; + } + + if (Utils.isNode) { + return new Uint8Array(Buffer.from(str, "base64")); + } else { + const binaryString = Utils.global.atob(str); + const bytes = new Uint8Array(binaryString.length); + for (let i = 0; i < binaryString.length; i++) { + bytes[i] = binaryString.charCodeAt(i); + } + return bytes; + } + } + + static fromUrlB64ToArray(str: string): Uint8Array { + return Utils.fromB64ToArray(Utils.fromUrlB64ToB64(str)); + } + + static fromHexToArray(str: string): Uint8Array { + if (Utils.isNode) { + return new Uint8Array(Buffer.from(str, "hex")); + } else { + const bytes = new Uint8Array(str.length / 2); + for (let i = 0; i < str.length; i += 2) { + bytes[i / 2] = parseInt(str.substr(i, 2), 16); + } + return bytes; + } + } + + static fromUtf8ToArray(str: string): Uint8Array { + if (Utils.isNode) { + return new Uint8Array(Buffer.from(str, "utf8")); + } else { + const strUtf8 = unescape(encodeURIComponent(str)); + const arr = new Uint8Array(strUtf8.length); + for (let i = 0; i < strUtf8.length; i++) { + arr[i] = strUtf8.charCodeAt(i); + } + return arr; + } + } + + static fromByteStringToArray(str: string): Uint8Array { + if (str == null) { + return null; + } + const arr = new Uint8Array(str.length); + for (let i = 0; i < str.length; i++) { + arr[i] = str.charCodeAt(i); + } + return arr; + } + + static fromBufferToB64(buffer: ArrayBuffer): string { + if (buffer == null) { + return null; + } + if (Utils.isNode) { + return Buffer.from(buffer).toString("base64"); + } else { + let binary = ""; + const bytes = new Uint8Array(buffer); + for (let i = 0; i < bytes.byteLength; i++) { + binary += String.fromCharCode(bytes[i]); + } + return Utils.global.btoa(binary); + } + } + + static fromBufferToUrlB64(buffer: ArrayBuffer): string { + return Utils.fromB64toUrlB64(Utils.fromBufferToB64(buffer)); + } + + static fromB64toUrlB64(b64Str: string) { + return b64Str.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, ""); + } + + static fromBufferToUtf8(buffer: ArrayBuffer): string { + return BufferLib.from(buffer).toString("utf8"); + } + + static fromBufferToByteString(buffer: ArrayBuffer): string { + return String.fromCharCode.apply(null, new Uint8Array(buffer)); + } + + // ref: https://stackoverflow.com/a/40031979/1090359 + static fromBufferToHex(buffer: ArrayBuffer): string { + if (Utils.isNode) { + return Buffer.from(buffer).toString("hex"); + } else { + const bytes = new Uint8Array(buffer); + return Array.prototype.map + .call(bytes, (x: number) => ("00" + x.toString(16)).slice(-2)) + .join(""); + } + } + + /** + * Converts a hex string to an ArrayBuffer. + * Note: this doesn't need any Node specific code as parseInt() / ArrayBuffer / Uint8Array + * work the same in Node and the browser. + * @param {string} hexString - A string of hexadecimal characters. + * @returns {ArrayBuffer} The ArrayBuffer representation of the hex string. + */ + static hexStringToArrayBuffer(hexString: string): ArrayBuffer { + // Check if the hexString has an even length, as each hex digit represents half a byte (4 bits), + // and it takes two hex digits to represent a full byte (8 bits). + if (hexString.length % 2 !== 0) { + throw "HexString has to be an even length"; + } + + // Create an ArrayBuffer with a length that is half the length of the hex string, + // because each pair of hex digits will become a single byte. + const arrayBuffer = new ArrayBuffer(hexString.length / 2); + + // Create a Uint8Array view on top of the ArrayBuffer (each position represents a byte) + // as ArrayBuffers cannot be edited directly. + const uint8Array = new Uint8Array(arrayBuffer); + + // Loop through the bytes + for (let i = 0; i < uint8Array.length; i++) { + // Extract two hex characters (1 byte) + const hexByte = hexString.substr(i * 2, 2); + + // Convert hexByte into a decimal value from base 16. (ex: ff --> 255) + const byteValue = parseInt(hexByte, 16); + + // Place the byte value into the uint8Array + uint8Array[i] = byteValue; + } + + return arrayBuffer; + } + + static fromUrlB64ToB64(urlB64Str: string): string { + let output = urlB64Str.replace(/-/g, "+").replace(/_/g, "/"); + switch (output.length % 4) { + case 0: + break; + case 2: + output += "=="; + break; + case 3: + output += "="; + break; + default: + throw new Error("Illegal base64url string!"); + } + + return output; + } + + static fromUrlB64ToUtf8(urlB64Str: string): string { + return Utils.fromB64ToUtf8(Utils.fromUrlB64ToB64(urlB64Str)); + } + + static fromUtf8ToB64(utfStr: string): string { + if (Utils.isNode) { + return Buffer.from(utfStr, "utf8").toString("base64"); + } else { + return BufferLib.from(utfStr, "utf8").toString("base64"); + } + } + + static fromUtf8ToUrlB64(utfStr: string): string { + return Utils.fromBufferToUrlB64(Utils.fromUtf8ToArray(utfStr)); + } + + static fromB64ToUtf8(b64Str: string): string { + if (Utils.isNode) { + return Buffer.from(b64Str, "base64").toString("utf8"); + } else { + return BufferLib.from(b64Str, "base64").toString("utf8"); + } + } + + // ref: http://stackoverflow.com/a/2117523/1090359 + static newGuid(): string { + return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => { + const r = (Math.random() * 16) | 0; + const v = c === "x" ? r : (r & 0x3) | 0x8; + return v.toString(16); + }); + } + + static guidRegex = /^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$/; + + static isGuid(id: string) { + return RegExp(Utils.guidRegex, "i").test(id); + } + + static getHostname(uriString: string): string { + if (Utils.isNullOrWhitespace(uriString)) { + return null; + } + + uriString = uriString.trim(); + + if (uriString.startsWith("data:")) { + return null; + } + + if (uriString.startsWith("about:")) { + return null; + } + + if (uriString.startsWith("file:")) { + return null; + } + + // Does uriString contain invalid characters + // TODO Needs to possibly be extended, although '!' is a reserved character + if (uriString.indexOf("!") > 0) { + return null; + } + + try { + const hostname = getHostname(uriString, { validHosts: this.validHosts }); + if (hostname != null) { + return hostname; + } + } catch { + return null; + } + return null; + } + + static getHost(uriString: string): string { + const url = Utils.getUrl(uriString); + try { + return url != null && url.host !== "" ? url.host : null; + } catch { + return null; + } + } + + static getDomain(uriString: string): string { + if (Utils.isNullOrWhitespace(uriString)) { + return null; + } + + uriString = uriString.trim(); + + if (uriString.startsWith("data:")) { + return null; + } + + if (uriString.startsWith("about:")) { + return null; + } + + try { + const parseResult = parse(uriString, { + validHosts: this.validHosts, + allowPrivateDomains: true, + }); + if (parseResult != null && parseResult.hostname != null) { + if (parseResult.hostname === "localhost" || parseResult.isIp) { + return parseResult.hostname; + } + + if (parseResult.domain != null) { + return parseResult.domain; + } + return null; + } + } catch { + return null; + } + return null; + } + + static getQueryParams(uriString: string): Map { + const url = Utils.getUrl(uriString); + if (url == null || url.search == null || url.search === "") { + return null; + } + const map = new Map(); + const pairs = (url.search[0] === "?" ? url.search.substr(1) : url.search).split("&"); + pairs.forEach((pair) => { + const parts = pair.split("="); + if (parts.length < 1) { + return; + } + map.set( + decodeURIComponent(parts[0]).toLowerCase(), + parts[1] == null ? "" : decodeURIComponent(parts[1]), + ); + }); + return map; + } + + static getSortFunction( + i18nService: I18nService, + prop: { [K in keyof T]: T[K] extends string ? K : never }[keyof T], + ): (a: T, b: T) => number { + return (a, b) => { + if (a[prop] == null && b[prop] != null) { + return -1; + } + if (a[prop] != null && b[prop] == null) { + return 1; + } + if (a[prop] == null && b[prop] == null) { + return 0; + } + + // The `as unknown as string` here is unfortunate because typescript doesn't property understand that the return of T[prop] will be a string + return i18nService.collator + ? i18nService.collator.compare(a[prop] as unknown as string, b[prop] as unknown as string) + : (a[prop] as unknown as string).localeCompare(b[prop] as unknown as string); + }; + } + + static isNullOrWhitespace(str: string): boolean { + return str == null || typeof str !== "string" || str.trim() === ""; + } + + static isNullOrEmpty(str: string | null): boolean { + return str == null || typeof str !== "string" || str == ""; + } + + static isPromise(obj: any): obj is Promise { + return ( + obj != undefined && typeof obj["then"] === "function" && typeof obj["catch"] === "function" + ); + } + + static nameOf(name: string & keyof T) { + return name; + } + + static assign(target: T, source: Partial): T { + return Object.assign(target, source); + } + + static iterateEnum(obj: O) { + return (Object.keys(obj).filter((k) => Number.isNaN(+k)) as K[]).map((k) => obj[k]); + } + + static getUrl(uriString: string): URL { + if (this.isNullOrWhitespace(uriString)) { + return null; + } + + uriString = uriString.trim(); + + return Utils.getUrlObject(uriString); + } + + static camelToPascalCase(s: string) { + return s.charAt(0).toUpperCase() + s.slice(1); + } + + /** + * There are a few ways to calculate text color for contrast, this one seems to fit accessibility guidelines best. + * https://stackoverflow.com/a/3943023/6869691 + * + * @param {string} bgColor + * @param {number} [threshold] see stackoverflow link above + * @param {boolean} [svgTextFill] + * Indicates if this method is performed on an SVG 'fill' attribute (e.g. ). + * This check is necessary because the '!important' tag cannot be used in a 'fill' attribute. + */ + static pickTextColorBasedOnBgColor(bgColor: string, threshold = 186, svgTextFill = false) { + const bgColorHexNums = bgColor.charAt(0) === "#" ? bgColor.substring(1, 7) : bgColor; + const r = parseInt(bgColorHexNums.substring(0, 2), 16); // hexToR + const g = parseInt(bgColorHexNums.substring(2, 4), 16); // hexToG + const b = parseInt(bgColorHexNums.substring(4, 6), 16); // hexToB + const blackColor = svgTextFill ? "black" : "black !important"; + const whiteColor = svgTextFill ? "white" : "white !important"; + return r * 0.299 + g * 0.587 + b * 0.114 > threshold ? blackColor : whiteColor; + } + + static stringToColor(str: string): string { + let hash = 0; + for (let i = 0; i < str.length; i++) { + hash = str.charCodeAt(i) + ((hash << 5) - hash); + } + let color = "#"; + for (let i = 0; i < 3; i++) { + const value = (hash >> (i * 8)) & 0xff; + color += ("00" + value.toString(16)).substr(-2); + } + return color; + } + + /** + * @throws Will throw an error if the ContainerService has not been attached to the window object + */ + static getContainerService(): BitwardenContainerService { + if (this.global.bitwardenContainerService == null) { + throw new Error("global bitwardenContainerService not initialized."); + } + return this.global.bitwardenContainerService; + } + + static validateHexColor(color: string) { + return /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/.test(color); + } + + /** + * Converts map to a Record with the same data. Inverse of recordToMap + * Useful in toJSON methods, since Maps are not serializable + * @param map + * @returns + */ + static mapToRecord(map: Map): Record { + if (map == null) { + return null; + } + if (!(map instanceof Map)) { + return map; + } + return Object.fromEntries(map); + } + + /** + * Converts record to a Map with the same data. Inverse of mapToRecord + * Useful in fromJSON methods, since Maps are not serializable + * + * Warning: If the record has string keys that are numbers, they will be converted to numbers in the map + * @param record + * @returns + */ + static recordToMap(record: Record): Map { + if (record == null) { + return null; + } else if (record instanceof Map) { + return record; + } + + const entries = Object.entries(record); + if (entries.length === 0) { + return new Map(); + } + + if (isNaN(Number(entries[0][0]))) { + return new Map(entries) as Map; + } else { + return new Map(entries.map((e) => [Number(e[0]), e[1]])) as Map; + } + } + + /** Applies Object.assign, but converts the type nicely using Type-Fest Merge */ + static merge( + destination: Destination, + source: Source, + ): Merge { + return Object.assign(destination, source) as unknown as Merge; + } + + /** + * encodeURIComponent escapes all characters except the following: + * alphabetic, decimal digits, - _ . ! ~ * ' ( ) + * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent#encoding_for_rfc3986 + */ + static encodeRFC3986URIComponent(str: string): string { + return encodeURIComponent(str).replace( + /[!'()*]/g, + (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`, + ); + } + + /** + * Normalizes a path for defense against attacks like traversals + * @param denormalizedPath + * @returns + */ + static normalizePath(denormalizedPath: string): string { + return path.normalize(decodeURIComponent(denormalizedPath)).replace(/^(\.\.(\/|\\|$))+/, ""); + } + + private static isMobile(win: Window) { + let mobile = false; + ((a) => { + if ( + /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test( + a, + ) || + /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test( + a.substr(0, 4), + ) + ) { + mobile = true; + } + })(win.navigator.userAgent || win.navigator.vendor || (win as any).opera); + return mobile || win.navigator.userAgent.match(/iPad/i) != null; + } + + static delay(ms: number): Promise { + return new Promise((resolve) => setTimeout(resolve, ms)); + } + + /** + * Generate an observable from a function that returns a promise. + * Similar to the rxjs function {@link from} with one big exception: + * {@link from} will not re-execute the function when observers resubscribe. + * {@link Util.asyncToObservable} will execute `generator` for every + * subscribe, making it ideal if the value ever needs to be refreshed. + * */ + static asyncToObservable(generator: () => Promise): Observable { + return of(undefined).pipe(switchMap(() => generator())); + } + + /** + * Return the number of days remaining before a target date arrives. + * Returns 0 if the day has already passed. + */ + static daysRemaining(targetDate: Date): number { + const diffTime = targetDate.getTime() - Date.now(); + const msPerDay = 86400000; + return Math.max(0, Math.floor(diffTime / msPerDay)); + } + + private static isAppleMobile(win: Window) { + return ( + win.navigator.userAgent.match(/iPhone/i) != null || + win.navigator.userAgent.match(/iPad/i) != null + ); + } + + private static getUrlObject(uriString: string): URL { + // All the methods below require a protocol to properly parse a URL string + // Assume http if no other protocol is present + const hasProtocol = uriString.indexOf("://") > -1; + if (!hasProtocol && uriString.indexOf(".") > -1) { + uriString = "http://" + uriString; + } else if (!hasProtocol) { + return null; + } + + try { + if (nodeURL != null) { + return new nodeURL.URL(uriString); + } + + return new URL(uriString); + // FIXME: Remove when updating file. Eslint update + // eslint-disable-next-line @typescript-eslint/no-unused-vars + } catch (e) { + // Ignore error + } + + return null; + } +} + +Utils.init();