@uxf/router 11.32.0 → 11.46.0

package/helper.d.ts

@@ -5,4 +5,5 @@ export declare function queryParamToBoolean(param: ParamType): boolean | undefin
 export declare function queryParamToBooleanStrict(param: ParamType): boolean;
 export declare function queryParamToNumber(param: ParamType): number | undefined;
 export declare function queryParamToNumberStrict(param: ParamType): number;
+export declare function queryParamToEnumStrict<T>(param: ParamType, enums: Record<string, any>, fallback: T): T;
 export {};

package/helper.js

@@ -6,6 +6,7 @@ exports.queryParamToBoolean = queryParamToBoolean;
 exports.queryParamToBooleanStrict = queryParamToBooleanStrict;
 exports.queryParamToNumber = queryParamToNumber;
 exports.queryParamToNumberStrict = queryParamToNumberStrict;
+exports.queryParamToEnumStrict = queryParamToEnumStrict;
 function queryParamToString(param) {
     if (Array.isArray(param)) {
         throw new Error(`Query parameter is array. Should be string.`);
@@ -61,3 +62,10 @@ function queryParamToNumberStrict(param) {
     }
     return paramOrUndefined;
 }
+function queryParamToEnumStrict(param, enums, fallback) {
+    const result = queryParamToString(Array.isArray(param) ? param.at(0) : param);
+    if (result && Object.values(enums).includes(result)) {
+        return result;
+    }
+    return fallback;
+}

package/helper.test.d.ts

@@ -0,0 +1 @@
+export {};

package/helper.test.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const helper_1 = require("./helper");
+describe("Query Parameter Functions", () => {
+    describe("queryParamToString", () => {
+        it("should return the string when provided", () => {
+            expect((0, helper_1.queryParamToString)("test")).toBe("test");
+        });
+        it("should return undefined when provided as undefined", () => {
+            expect((0, helper_1.queryParamToString)(undefined)).toBeUndefined();
+        });
+        it("should throw an error when provided an array", () => {
+            expect(() => (0, helper_1.queryParamToString)(["test"])).toThrowError("Query parameter is array. Should be string.");
+        });
+    });
+    describe("queryParamToStringStrict", () => {
+        it("should return the string when provided", () => {
+            expect((0, helper_1.queryParamToStringStrict)("test")).toBe("test");
+        });
+        it("should throw an error when provided as undefined", () => {
+            expect(() => (0, helper_1.queryParamToStringStrict)(undefined)).toThrowError("Parameter not found.");
+        });
+        it("should throw an error when provided an array", () => {
+            expect(() => (0, helper_1.queryParamToStringStrict)(["test"])).toThrowError("Query parameter is array. Should be string.");
+        });
+    });
+    describe("queryParamToBoolean", () => {
+        it('should return true when provided as "true"', () => {
+            expect((0, helper_1.queryParamToBoolean)("true")).toBe(true);
+        });
+        it('should return false when provided as "false"', () => {
+            expect((0, helper_1.queryParamToBoolean)("false")).toBe(false);
+        });
+        it("should return undefined when provided as undefined", () => {
+            expect((0, helper_1.queryParamToBoolean)(undefined)).toBeUndefined();
+        });
+        it("should throw an error when provided as an invalid boolean string", () => {
+            expect(() => (0, helper_1.queryParamToBoolean)("invalid")).toThrowError("Parameter should be boolean (true|false). Given 'invalid'.");
+        });
+        it("should throw an error when provided an array", () => {
+            expect(() => (0, helper_1.queryParamToBoolean)(["true"])).toThrowError("Query parameter is array. Should be string.");
+        });
+    });
+    describe("queryParamToBooleanStrict", () => {
+        it('should return true when provided as "true"', () => {
+            expect((0, helper_1.queryParamToBooleanStrict)("true")).toBe(true);
+        });
+        it('should return false when provided as "false"', () => {
+            expect((0, helper_1.queryParamToBooleanStrict)("false")).toBe(false);
+        });
+        it("should throw an error when provided as undefined", () => {
+            expect(() => (0, helper_1.queryParamToBooleanStrict)(undefined)).toThrowError("Parameter not found.");
+        });
+        it("should throw an error when provided an invalid boolean string", () => {
+            expect(() => (0, helper_1.queryParamToBooleanStrict)("invalid")).toThrowError("Parameter should be boolean (true|false). Given 'invalid'.");
+        });
+        it("should throw an error when provided an array", () => {
+            expect(() => (0, helper_1.queryParamToBooleanStrict)(["true"])).toThrowError("Query parameter is array. Should be string.");
+        });
+    });
+    describe("queryParamToNumber", () => {
+        it("should return a number when provided a valid string", () => {
+            expect((0, helper_1.queryParamToNumber)("123")).toBe(123);
+        });
+        it("should return undefined when provided as undefined", () => {
+            expect((0, helper_1.queryParamToNumber)(undefined)).toBeUndefined();
+        });
+        it("should throw an error when provided as an invalid number string", () => {
+            expect(() => (0, helper_1.queryParamToNumber)("invalid")).toThrowError("Query parameter is NaN. Should be number.");
+        });
+        it("should throw an error when provided an array", () => {
+            expect(() => (0, helper_1.queryParamToNumber)(["123"])).toThrowError("Query parameter is array. Should be number.");
+        });
+    });
+    describe("queryParamToNumberStrict", () => {
+        it("should return a number when provided a valid string", () => {
+            expect((0, helper_1.queryParamToNumberStrict)("123")).toBe(123);
+        });
+        it("should throw an error when provided as undefined", () => {
+            expect(() => (0, helper_1.queryParamToNumberStrict)(undefined)).toThrowError("Parameter not found.");
+        });
+        it("should throw an error when provided as an invalid number string", () => {
+            expect(() => (0, helper_1.queryParamToNumberStrict)("invalid")).toThrowError("Query parameter is NaN. Should be number.");
+        });
+        it("should throw an error when provided an array", () => {
+            expect(() => (0, helper_1.queryParamToNumberStrict)(["123"])).toThrowError("Query parameter is array. Should be number.");
+        });
+    });
+});

package/package.json

@@ -1,35 +1,35 @@
 {
-  "name": "@uxf/router",
-  "version": "11.32.0",
-  "description": "UXF Router",
-  "author": "UXFans <dev@uxf.cz>",
-  "homepage": "https://gitlab.com/uxf-npm/router#readme",
-  "license": "ISC",
-  "main": "index.js",
-  "typings": "index.d.ts",
-  "module": "index.js",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://gitlab.com/uxf-npm/router.git"
-  },
-  "scripts": {
-    "build": "tsc -P tsconfig.json",
-    "typecheck": "tsc --noEmit --skipLibCheck"
-  },
-  "bugs": {
-    "url": "https://gitlab.com/uxf-npm/router/issues"
-  },
-  "dependencies": {
-    "qs": "6.13.0"
-  },
-  "peerDependencies": {
-    "next": ">= 12"
-  },
-  "devDependencies": {
-    "@types/qs": "6.9.15",
-    "next": "14.2.6"
-  }
-}
+    "name": "@uxf/router",
+    "version": "11.46.0",
+    "description": "UXF Router",
+    "author": "UXFans <dev@uxf.cz>",
+    "homepage": "https://gitlab.com/uxf-npm/router#readme",
+    "license": "ISC",
+    "main": "index.js",
+    "typings": "index.d.ts",
+    "module": "index.js",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://gitlab.com/uxf-npm/router.git"
+    },
+    "scripts": {
+        "build": "tsc -P tsconfig.json",
+        "typecheck": "tsc --noEmit --skipLibCheck"
+    },
+    "bugs": {
+        "url": "https://gitlab.com/uxf-npm/router/issues"
+    },
+    "dependencies": {
+        "qs": "6.13.0"
+    },
+    "peerDependencies": {
+        "next": ">= 12"
+    },
+    "devDependencies": {
+        "@types/qs": "6.9.15",
+        "next": "14.2.6"
+    }
+}

package/utils/object-to-xml.test.d.ts

@@ -0,0 +1 @@
+export {};

package/utils/object-to-xml.test.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const object_to_xml_1 = require("./object-to-xml");
+describe("objectToXml", () => {
+    it("should convert a simple object to XML format", () => {
+        const input = {
+            name: "John Doe",
+            age: 30,
+            city: "New York",
+        };
+        const expectedOutput = `        <name>John Doe</name>
+        <age>30</age>
+        <city>New York</city>`;
+        expect((0, object_to_xml_1.objectToXml)(input)).toBe(expectedOutput);
+    });
+    it("should ignore null and undefined values", () => {
+        const input = {
+            name: "John Doe",
+            age: null,
+            city: undefined,
+            country: "USA",
+        };
+        const expectedOutput = `        <name>John Doe</name>
+        <country>USA</country>`;
+        expect((0, object_to_xml_1.objectToXml)(input)).toBe(expectedOutput);
+    });
+    it("should handle empty objects", () => {
+        const input = {};
+        const expectedOutput = "";
+        expect((0, object_to_xml_1.objectToXml)(input)).toBe(expectedOutput);
+    });
+    it("should handle numeric values", () => {
+        const input = {
+            a: 1,
+            b: 2.5,
+            c: 0,
+        };
+        const expectedOutput = `        <a>1</a>
+        <b>2.5</b>
+        <c>0</c>`;
+        expect((0, object_to_xml_1.objectToXml)(input)).toBe(expectedOutput);
+    });
+});