@jam-comments/server-utilities 3.0.1 → 3.1.0

package/dist/cjs/markupFetcher.js

@@ -1,12 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.markupFetcher = void 0;
+const utils_1 = require("./utils");
 const markupFetcher = (platform, fetchImplementation = fetch) => {
-    return async ({ path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = "production", }) => {
+    return async ({ tz = undefined, path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = "production", }) => {
+        if (tz && !(0, utils_1.isValidTimezone)(tz)) {
+            throw new Error(`The timezone passed to JamComments is invalid: ${tz}`);
+        }
         const params = new URLSearchParams({
             path: path || "/",
             domain,
         });
+        if (tz) {
+            params.set("tz", tz);
+        }
         if (environment !== "production") {
             params.set("stub", "true");
         }

package/dist/cjs/markupFetcher.test.js

@@ -109,4 +109,34 @@ const markupFetcher_1 = require("./markupFetcher");
             apiKey: "123abc",
         })).rejects.toThrowError(/request failed! Status code: 500/);
     });
+    (0, vitest_1.describe)("timezone validation", () => {
+        (0, vitest_1.it)("throws error when invalid timezone is provided", async () => {
+            const fetchMock = vitest_1.vi.fn();
+            const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+            (0, vitest_1.expect)(fetchMock).not.toHaveBeenCalled();
+            (0, vitest_1.expect)(fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                tz: "in/valid",
+            })).rejects.toThrowError("The timezone passed to JamComments is invalid: in/valid");
+        });
+        (0, vitest_1.it)("does not throw error when valid timezone is provided", async () => {
+            const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+                return {
+                    status: 200,
+                    ok: true,
+                    text: () => "results!",
+                };
+            });
+            const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+            const result = await fetcher({
+                path: null,
+                domain: "test.com",
+                tz: "America/New_York",
+            });
+            (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2F&domain=test.com&tz=America%2FNew_York", vitest_1.expect.anything());
+            (0, vitest_1.expect)(result).toEqual("results!");
+        });
+    });
 });

package/dist/cjs/utils.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidTimezone = void 0;
+function isValidTimezone(tz) {
+    try {
+        Intl.DateTimeFormat(undefined, { timeZone: tz });
+        return true;
+    }
+    catch (ex) {
+        return false;
+    }
+}
+exports.isValidTimezone = isValidTimezone;

package/dist/esm/markupFetcher.js

@@ -1,9 +1,16 @@
+import { isValidTimezone } from "./utils";
 export const markupFetcher = (platform, fetchImplementation = fetch) => {
-    return async ({ path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = "production", }) => {
+    return async ({ tz = undefined, path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = "production", }) => {
+        if (tz && !isValidTimezone(tz)) {
+            throw new Error(`The timezone passed to JamComments is invalid: ${tz}`);
+        }
         const params = new URLSearchParams({
             path: path || "/",
             domain,
         });
+        if (tz) {
+            params.set("tz", tz);
+        }
         if (environment !== "production") {
             params.set("stub", "true");
         }

package/dist/esm/markupFetcher.test.js

@@ -107,4 +107,34 @@ describe("markupFetcher", () => {
             apiKey: "123abc",
         })).rejects.toThrowError(/request failed! Status code: 500/);
     });
+    describe("timezone validation", () => {
+        it("throws error when invalid timezone is provided", async () => {
+            const fetchMock = vi.fn();
+            const fetcher = markupFetcher("test", fetchMock);
+            expect(fetchMock).not.toHaveBeenCalled();
+            expect(fetcher({
+                path: "/test",
+                domain: "test.com",
+                apiKey: "123abc",
+                tz: "in/valid",
+            })).rejects.toThrowError("The timezone passed to JamComments is invalid: in/valid");
+        });
+        it("does not throw error when valid timezone is provided", async () => {
+            const fetchMock = vi.fn().mockImplementation(() => {
+                return {
+                    status: 200,
+                    ok: true,
+                    text: () => "results!",
+                };
+            });
+            const fetcher = markupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: null,
+                domain: "test.com",
+                tz: "America/New_York",
+            });
+            expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2F&domain=test.com&tz=America%2FNew_York", expect.anything());
+            expect(result).toEqual("results!");
+        });
+    });
 });

package/dist/esm/utils.js

@@ -0,0 +1,9 @@
+export function isValidTimezone(tz) {
+    try {
+        Intl.DateTimeFormat(undefined, { timeZone: tz });
+        return true;
+    }
+    catch (ex) {
+        return false;
+    }
+}

package/dist/types/utils.d.ts

@@ -0,0 +1 @@
+export declare function isValidTimezone(tz: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Various JavaScript utilities for JamComments.",
   "main": "dist/cjs/index.js",
   "types": "dist/types/index.d.ts",
@@ -21,11 +21,11 @@
   "homepage": "https://jamcomments.com",
   "license": "GPL-2.0",
   "devDependencies": {
-    "@types/node": "^18.15.8",
-    "prettier": "^2.8.7",
-    "typescript": "^5.0.2",
-    "vite": "^4.2.1",
-    "vitest": "^0.29.7"
+    "@types/node": "^20.2.5",
+    "prettier": "^2.8.8",
+    "typescript": "^5.0.4",
+    "vite": "^4.3.9",
+    "vitest": "^0.31.1"
   },
   "publishConfig": {
     "access": "public"