@jam-comments/server-utilities 3.0.1 → 3.2.0

package/dist/cjs/markupFetcher.js

@@ -1,12 +1,20 @@
 "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 = (0, utils_1.getEnvironment)(), }) => {
+        const trimmedTimezone = tz?.trim();
+        if (trimmedTimezone && !(0, utils_1.isValidTimezone)(trimmedTimezone)) {
+            throw new Error(`The timezone passed to JamComments is invalid: ${trimmedTimezone}`);
+        }
         const params = new URLSearchParams({
             path: path || "/",
             domain,
         });
+        if (trimmedTimezone) {
+            params.set("tz", trimmedTimezone);
+        }
         if (environment !== "production") {
             params.set("stub", "true");
         }

package/dist/cjs/markupFetcher.test.js

@@ -16,6 +16,7 @@ const markupFetcher_1 = require("./markupFetcher");
             path: "/test",
             domain: "test.com",
             apiKey: "123abc",
+            environment: "production",
         });
         (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2Ftest&domain=test.com", vitest_1.expect.objectContaining({
             headers: vitest_1.expect.objectContaining({
@@ -59,6 +60,26 @@ const markupFetcher_1 = require("./markupFetcher");
             domain: "test.com",
             apiKey: "123abc",
             baseUrl: "http://ur-mom.com",
+            environment: "production",
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/v2/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("respects production!!!", 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: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            baseUrl: "http://ur-mom.com",
+            environment: "production",
         });
         (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/v2/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
         (0, vitest_1.expect)(result).toEqual("results!");
@@ -75,6 +96,8 @@ const markupFetcher_1 = require("./markupFetcher");
         const result = await fetcher({
             path: null,
             domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
         });
         (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2F&domain=test.com", vitest_1.expect.anything());
         (0, vitest_1.expect)(result).toEqual("results!");
@@ -109,4 +132,56 @@ 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",
+                environment: "production",
+            })).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",
+                apiKey: "123abc",
+                tz: "America/New_York",
+                environment: "production",
+            });
+            (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!");
+        });
+        (0, vitest_1.it)("trims a valid timezone", 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",
+                apiKey: "123abc",
+                tz: "   America/Chicago   ",
+                environment: "production",
+            });
+            (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2F&domain=test.com&tz=America%2FChicago", vitest_1.expect.anything());
+            (0, vitest_1.expect)(result).toEqual("results!");
+        });
+    });
 });

package/dist/cjs/utils.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvironment = exports.isValidTimezone = void 0;
+function isValidTimezone(tz) {
+    try {
+        Intl.DateTimeFormat(undefined, { timeZone: tz });
+        return true;
+    }
+    catch (ex) {
+        return false;
+    }
+}
+exports.isValidTimezone = isValidTimezone;
+function getEnvironment() {
+    if (typeof process === "undefined") {
+        return "production";
+    }
+    return process.env?.NODE_ENV || "development";
+}
+exports.getEnvironment = getEnvironment;

package/dist/cjs/utils.test.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const utils_1 = require("./utils");
+const env = process.env;
+(0, vitest_1.beforeEach)(() => {
+    vitest_1.vi.resetModules();
+    process.env = { ...env };
+});
+(0, vitest_1.afterEach)(() => {
+    process.env = env;
+});
+(0, vitest_1.describe)("getEnvironment()", () => {
+    (0, vitest_1.it)("returns environment", () => {
+        (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("test");
+    });
+    (0, vitest_1.it)("falls back to development", () => {
+        process.env.NODE_ENV = undefined;
+        (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("development");
+    });
+    (0, vitest_1.it)("returns production environment", () => {
+        process.env.NODE_ENV = "production";
+        (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("production");
+    });
+});

package/dist/esm/markupFetcher.js

@@ -1,9 +1,17 @@
+import { getEnvironment, 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 = getEnvironment(), }) => {
+        const trimmedTimezone = tz?.trim();
+        if (trimmedTimezone && !isValidTimezone(trimmedTimezone)) {
+            throw new Error(`The timezone passed to JamComments is invalid: ${trimmedTimezone}`);
+        }
         const params = new URLSearchParams({
             path: path || "/",
             domain,
         });
+        if (trimmedTimezone) {
+            params.set("tz", trimmedTimezone);
+        }
         if (environment !== "production") {
             params.set("stub", "true");
         }

package/dist/esm/markupFetcher.test.js

@@ -14,6 +14,7 @@ describe("markupFetcher", () => {
             path: "/test",
             domain: "test.com",
             apiKey: "123abc",
+            environment: "production",
         });
         expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2Ftest&domain=test.com", expect.objectContaining({
             headers: expect.objectContaining({
@@ -57,6 +58,26 @@ describe("markupFetcher", () => {
             domain: "test.com",
             apiKey: "123abc",
             baseUrl: "http://ur-mom.com",
+            environment: "production",
+        });
+        expect(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/v2/markup?path=%2Ftest&domain=test.com", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("respects production!!!", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = markupFetcher("test", fetchMock);
+        const result = await fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            baseUrl: "http://ur-mom.com",
+            environment: "production",
         });
         expect(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/v2/markup?path=%2Ftest&domain=test.com", expect.anything());
         expect(result).toEqual("results!");
@@ -73,6 +94,8 @@ describe("markupFetcher", () => {
         const result = await fetcher({
             path: null,
             domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
         });
         expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2F&domain=test.com", expect.anything());
         expect(result).toEqual("results!");
@@ -107,4 +130,56 @@ 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",
+                environment: "production",
+            })).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",
+                apiKey: "123abc",
+                tz: "America/New_York",
+                environment: "production",
+            });
+            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!");
+        });
+        it("trims a valid timezone", 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",
+                apiKey: "123abc",
+                tz: "   America/Chicago   ",
+                environment: "production",
+            });
+            expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v2/markup?path=%2F&domain=test.com&tz=America%2FChicago", expect.anything());
+            expect(result).toEqual("results!");
+        });
+    });
 });

package/dist/esm/utils.js

@@ -0,0 +1,15 @@
+export function isValidTimezone(tz) {
+    try {
+        Intl.DateTimeFormat(undefined, { timeZone: tz });
+        return true;
+    }
+    catch (ex) {
+        return false;
+    }
+}
+export function getEnvironment() {
+    if (typeof process === "undefined") {
+        return "production";
+    }
+    return process.env?.NODE_ENV || "development";
+}

package/dist/esm/utils.test.js

@@ -0,0 +1,23 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { getEnvironment } from "./utils";
+const env = process.env;
+beforeEach(() => {
+    vi.resetModules();
+    process.env = { ...env };
+});
+afterEach(() => {
+    process.env = env;
+});
+describe("getEnvironment()", () => {
+    it("returns environment", () => {
+        expect(getEnvironment()).toEqual("test");
+    });
+    it("falls back to development", () => {
+        process.env.NODE_ENV = undefined;
+        expect(getEnvironment()).toEqual("development");
+    });
+    it("returns production environment", () => {
+        process.env.NODE_ENV = "production";
+        expect(getEnvironment()).toEqual("production");
+    });
+});

package/dist/types/markupFetcher.d.ts

@@ -1 +1,10 @@
-export declare const markupFetcher: (platform: string, fetchImplementation?: typeof fetch) => Function;
+interface IFetchData {
+    path: string;
+    domain: string;
+    apiKey: string;
+    tz?: string;
+    baseUrl?: string;
+    environment?: string;
+}
+export declare const markupFetcher: (platform: string, fetchImplementation?: typeof fetch) => (args: IFetchData) => Promise<string>;
+export {};

package/dist/types/utils.d.ts

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

package/dist/types/utils.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "3.0.1",
+  "version": "3.2.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"