@jam-comments/server-utilities 5.10.2 → 5.12.0

package/dist/cjs/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Store = exports.logError = exports.log = exports.removeFalseyValues = exports.fetchAll = exports.markupFetcher = void 0;
+exports.Store = exports.logError = exports.log = exports.removeFalseyValues = exports.fetchAll = exports.markupFetcher = exports.simpleMarkupFetcher = void 0;
+var simpleMarkupFetcher_1 = require("./simpleMarkupFetcher");
+Object.defineProperty(exports, "simpleMarkupFetcher", { enumerable: true, get: function () { return simpleMarkupFetcher_1.simpleMarkupFetcher; } });
 var markupFetcher_1 = require("./markupFetcher");
 Object.defineProperty(exports, "markupFetcher", { enumerable: true, get: function () { return markupFetcher_1.markupFetcher; } });
 Object.defineProperty(exports, "fetchAll", { enumerable: true, get: function () { return markupFetcher_1.fetchAll; } });

package/dist/cjs/markupFetcher.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_URL = void 0;
 exports.fetchAll = fetchAll;
 exports.batchMarkupFetcher = batchMarkupFetcher;
 exports.fetchFreshMarkup = fetchFreshMarkup;
@@ -8,8 +9,8 @@ exports.markupFetcher = markupFetcher;
 const injectSchema_1 = require("./injectSchema");
 const utils_1 = require("./utils");
 const store_1 = require("./store");
-const BASE_URL = "https://go.jamcomments.com";
-async function fetchAll({ tz = undefined, dateFormat = undefined, domain, apiKey, baseUrl = BASE_URL, environment = (0, utils_1.getEnvironment)(), copy = {}, }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher, store = new store_1.Store()) {
+exports.BASE_URL = "https://go.jamcomments.com";
+async function fetchAll({ tz = undefined, dateFormat = undefined, domain, apiKey, baseUrl = exports.BASE_URL, environment = (0, utils_1.getEnvironment)(), copy = {}, }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher, store = new store_1.Store()) {
     const fetchBatchMarkup = batchMarkupFetcherImpl(platform, fetchImplementation);
     let shouldKeepFetching = true;
     let page = 1;
@@ -45,16 +46,16 @@ async function fetchAll({ tz = undefined, dateFormat = undefined, domain, apiKey
     return store.store;
 }
 function batchMarkupFetcher(platform, fetchImplementation = fetch) {
-    return async ({ tz, copy, domain, apiKey, dateFormat, baseUrl = BASE_URL, environment = (0, utils_1.getEnvironment)(), page = 1, }) => {
+    return async ({ tz, copy, domain, apiKey, dateFormat, baseUrl = exports.BASE_URL, environment = (0, utils_1.getEnvironment)(), page = 1, }) => {
         const response = await makeMarkupRequest({ tz, domain, apiKey, baseUrl, environment, page, copy, dateFormat }, "/api/v3/markup/all", fetchImplementation, platform);
         return response.json();
     };
 }
-async function fetchFreshMarkup({ tz, path, copy, domain, apiKey, dateFormat, baseUrl = BASE_URL, environment = (0, utils_1.getEnvironment)(), }, fetchImplementation = fetch, platform) {
-    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat }, "/api/v3/markup", fetchImplementation, platform);
+async function fetchFreshMarkup({ tz, path, copy, cache, domain, apiKey, dateFormat, baseUrl = exports.BASE_URL, environment = (0, utils_1.getEnvironment)(), }, fetchImplementation = fetch, platform) {
+    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat, cache }, "/api/v3/markup", fetchImplementation, platform);
     return response.text();
 }
-async function makeMarkupRequest({ tz, path, page, domain, apiKey, dateFormat, copy = {}, baseUrl = BASE_URL, environment = (0, utils_1.getEnvironment)(), }, baseServicePath, fetchImplementation = fetch, platform) {
+async function makeMarkupRequest({ tz, path, page, cache, domain, apiKey, dateFormat, copy = {}, baseUrl = exports.BASE_URL, environment = (0, utils_1.getEnvironment)(), }, baseServicePath, fetchImplementation = fetch, platform) {
     const trimmedTimezone = tz?.trim();
     if (trimmedTimezone && !(0, utils_1.isValidTimezone)(trimmedTimezone)) {
         throw new Error(`The timezone passed to JamComments is invalid: ${trimmedTimezone}`);
@@ -62,6 +63,10 @@ async function makeMarkupRequest({ tz, path, page, domain, apiKey, dateFormat, c
     const params = new URLSearchParams({
         domain,
     });
+    if (cache !== undefined) {
+        console.info("DOING IT", cache);
+        params.set("cache", cache.toString());
+    }
     if (path) {
         params.set("path", path);
     }
@@ -98,7 +103,7 @@ async function makeMarkupRequest({ tz, path, page, domain, apiKey, dateFormat, c
     return response;
 }
 function markupFetcher(platform, fetchImplementation = fetch, store = new store_1.Store()) {
-    return async ({ tz = undefined, path, domain, apiKey, schema, dateFormat, baseUrl = BASE_URL, environment = (0, utils_1.getEnvironment)(), copy = {}, }) => {
+    return async ({ tz = undefined, path, cache, domain, apiKey, schema, dateFormat, baseUrl = exports.BASE_URL, environment = (0, utils_1.getEnvironment)(), copy = {}, }) => {
         path = path || "/";
         const cachedMarkup = (() => {
             if (!store.hasData) {
@@ -108,7 +113,17 @@ function markupFetcher(platform, fetchImplementation = fetch, store = new store_
         })();
         const markup = cachedMarkup
             ? cachedMarkup
-            : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat }, fetchImplementation, platform);
+            : await fetchFreshMarkup({
+                tz,
+                path,
+                domain,
+                apiKey,
+                baseUrl,
+                environment,
+                copy,
+                dateFormat,
+                cache,
+            }, fetchImplementation, platform);
         if (schema) {
             const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
             const parsedSchema = (0, utils_1.parseJson)(preparedSchema);

package/dist/cjs/markupFetcher.test.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const vitest_1 = require("vitest");
 const injectSchema = __importStar(require("./injectSchema"));
@@ -359,6 +369,25 @@ const { markupFetcher, batchMarkupFetcher } = fetcherExports;
         (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest&stub=true", vitest_1.expect.anything());
         (0, vitest_1.expect)(result).toEqual("results!");
     });
+    (0, vitest_1.it)("sets cache control header on response", async () => {
+        const fetchMock = vitest_1.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",
+            environment: "development",
+            cache: true,
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&cache=true&path=%2Ftest&stub=true", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
     (0, vitest_1.it)("uses different base URL", async () => {
         const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
             return {

package/dist/cjs/simpleMarkupFetcher.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simpleMarkupFetcher = simpleMarkupFetcher;
+const injectSchema_1 = require("./injectSchema");
+const markupFetcher_1 = require("./markupFetcher");
+const utils_1 = require("./utils");
+function simpleMarkupFetcher(platform, fetchImplementation = fetch) {
+    return async ({ tz = undefined, path, domain, apiKey, schema, dateFormat, baseUrl = markupFetcher_1.BASE_URL, environment = (0, utils_1.getEnvironment)(), copy = {}, }) => {
+        path = path || "/";
+        const markup = await (0, markupFetcher_1.fetchFreshMarkup)({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat }, fetchImplementation, platform);
+        if (schema) {
+            const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
+            const parsedSchema = (0, utils_1.parseJson)(preparedSchema);
+            if (!parsedSchema) {
+                return markup;
+            }
+            return (0, injectSchema_1.injectSchema)(markup, parsedSchema);
+        }
+        return markup;
+    };
+}

package/dist/cjs/simpleMarkupFetcher.test.js

@@ -0,0 +1,301 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const injectSchema = __importStar(require("./injectSchema"));
+const vitest_1 = require("vitest");
+const simpleMarkupFetcher_1 = require("./simpleMarkupFetcher");
+(0, vitest_1.describe)("simpleMarkupFetcher", () => {
+    (0, vitest_1.it)("constructs fetch request correctly", async () => {
+        const injectSchemaSpy = vitest_1.vi.spyOn(injectSchema, "injectSchema");
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        const result = await fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+        });
+        (0, vitest_1.expect)(injectSchemaSpy).not.toHaveBeenCalled();
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest", vitest_1.expect.objectContaining({
+            headers: vitest_1.expect.objectContaining({
+                Accept: "application/json",
+                Authorization: "Bearer 123abc",
+                "X-Platform": "test",
+            }),
+            method: "GET",
+        }));
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("stubs comments", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        const result = await fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "development",
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest&stub=true", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("uses different base URL", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("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/v3/markup?domain=test.com&path=%2Ftest", 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, simpleMarkupFetcher_1.simpleMarkupFetcher)("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/v3/markup?domain=test.com&path=%2Ftest", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("falls back to root path", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        const result = await fetcher({
+            path: null,
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2F", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("credentials are invalid", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 401,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        (0, vitest_1.expect)(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+        })).rejects.toThrowError(/Unauthorized!/);
+    });
+    (0, vitest_1.it)("response isn't ok", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        (0, vitest_1.expect)(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+        })).rejects.toThrowError(/request failed! Status code: 500/);
+    });
+    (0, vitest_1.it)("passes custom copy", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        const result = await fetcher({
+            path: null,
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+            copy: {
+                copy_confirmation_message: "custom confirmation message",
+                copy_submit_button: "custom submit button",
+            },
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2F&copy_confirmation_message=custom+confirmation+message&copy_submit_button=custom+submit+button", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("passes date format string", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        await fetcher({
+            path: null,
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+            dateFormat: "yyyy-MM-dd",
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2F&date_format=yyyy-MM-dd", vitest_1.expect.anything());
+    });
+    (0, vitest_1.it)("response isn't ok", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+        (0, vitest_1.expect)(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+        })).rejects.toThrowError(/request failed! Status code: 500/);
+    });
+    (0, vitest_1.describe)("copy overrides", () => {
+        (0, vitest_1.it)("encodes copy overrides", async () => {
+            const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+                return {
+                    status: 200,
+                    ok: true,
+                    text: () => "results!",
+                };
+            });
+            const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+            await fetcher({
+                path: "/some/path",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+                copy: {
+                    copy_confirmation_message: "custom confirmation message",
+                    copy_submit_button: "custom submit button",
+                },
+            });
+            (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Fsome%2Fpath&copy_confirmation_message=custom+confirmation+message&copy_submit_button=custom+submit+button", vitest_1.expect.anything());
+        });
+    });
+    (0, vitest_1.describe)("timezone validation", () => {
+        (0, vitest_1.it)("throws error when invalid timezone is provided", async () => {
+            const fetchImplMock = vitest_1.vi.fn();
+            const fetcher = (0, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchImplMock);
+            (0, vitest_1.expect)(fetchImplMock).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, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+            const result = await fetcher({
+                path: "/some/path",
+                domain: "test.com",
+                apiKey: "123abc",
+                tz: "America/New_York",
+                environment: "production",
+            });
+            (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Fsome%2Fpath&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, simpleMarkupFetcher_1.simpleMarkupFetcher)("test", fetchMock);
+            const result = await fetcher({
+                path: "/some/path",
+                domain: "test.com",
+                apiKey: "123abc",
+                tz: "   America/Chicago   ",
+                environment: "production",
+            });
+            (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Fsome%2Fpath&tz=America%2FChicago", vitest_1.expect.anything());
+            (0, vitest_1.expect)(result).toEqual("results!");
+        });
+    });
+});

package/dist/esm/index.js

@@ -1,3 +1,4 @@
+export { simpleMarkupFetcher } from "./simpleMarkupFetcher";
 export { markupFetcher, fetchAll } from "./markupFetcher";
 export { removeFalseyValues } from "./utils";
 export { log, logError } from "./log";

package/dist/esm/markupFetcher.js

@@ -1,7 +1,7 @@
 import { injectSchema } from "./injectSchema";
 import { getEnvironment, isValidTimezone, parseJson } from "./utils";
 import { Store } from "./store";
-const BASE_URL = "https://go.jamcomments.com";
+export const BASE_URL = "https://go.jamcomments.com";
 export async function fetchAll({ tz = undefined, dateFormat = undefined, domain, apiKey, baseUrl = BASE_URL, environment = getEnvironment(), copy = {}, }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher, store = new Store()) {
     const fetchBatchMarkup = batchMarkupFetcherImpl(platform, fetchImplementation);
     let shouldKeepFetching = true;
@@ -43,11 +43,11 @@ export function batchMarkupFetcher(platform, fetchImplementation = fetch) {
         return response.json();
     };
 }
-export async function fetchFreshMarkup({ tz, path, copy, domain, apiKey, dateFormat, baseUrl = BASE_URL, environment = getEnvironment(), }, fetchImplementation = fetch, platform) {
-    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat }, "/api/v3/markup", fetchImplementation, platform);
+export async function fetchFreshMarkup({ tz, path, copy, cache, domain, apiKey, dateFormat, baseUrl = BASE_URL, environment = getEnvironment(), }, fetchImplementation = fetch, platform) {
+    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat, cache }, "/api/v3/markup", fetchImplementation, platform);
     return response.text();
 }
-export async function makeMarkupRequest({ tz, path, page, domain, apiKey, dateFormat, copy = {}, baseUrl = BASE_URL, environment = getEnvironment(), }, baseServicePath, fetchImplementation = fetch, platform) {
+export async function makeMarkupRequest({ tz, path, page, cache, domain, apiKey, dateFormat, copy = {}, baseUrl = BASE_URL, environment = getEnvironment(), }, baseServicePath, fetchImplementation = fetch, platform) {
     const trimmedTimezone = tz?.trim();
     if (trimmedTimezone && !isValidTimezone(trimmedTimezone)) {
         throw new Error(`The timezone passed to JamComments is invalid: ${trimmedTimezone}`);
@@ -55,6 +55,10 @@ export async function makeMarkupRequest({ tz, path, page, domain, apiKey, dateFo
     const params = new URLSearchParams({
         domain,
     });
+    if (cache !== undefined) {
+        console.info("DOING IT", cache);
+        params.set("cache", cache.toString());
+    }
     if (path) {
         params.set("path", path);
     }
@@ -91,7 +95,7 @@ export async function makeMarkupRequest({ tz, path, page, domain, apiKey, dateFo
     return response;
 }
 export function markupFetcher(platform, fetchImplementation = fetch, store = new Store()) {
-    return async ({ tz = undefined, path, domain, apiKey, schema, dateFormat, baseUrl = BASE_URL, environment = getEnvironment(), copy = {}, }) => {
+    return async ({ tz = undefined, path, cache, domain, apiKey, schema, dateFormat, baseUrl = BASE_URL, environment = getEnvironment(), copy = {}, }) => {
         path = path || "/";
         const cachedMarkup = (() => {
             if (!store.hasData) {
@@ -101,7 +105,17 @@ export function markupFetcher(platform, fetchImplementation = fetch, store = new
         })();
         const markup = cachedMarkup
             ? cachedMarkup
-            : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat }, fetchImplementation, platform);
+            : await fetchFreshMarkup({
+                tz,
+                path,
+                domain,
+                apiKey,
+                baseUrl,
+                environment,
+                copy,
+                dateFormat,
+                cache,
+            }, fetchImplementation, platform);
         if (schema) {
             const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
             const parsedSchema = parseJson(preparedSchema);

package/dist/esm/markupFetcher.test.js

@@ -334,6 +334,25 @@ describe("markupFetcher", () => {
         expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest&stub=true", expect.anything());
         expect(result).toEqual("results!");
     });
+    it("sets cache control header on response", 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",
+            environment: "development",
+            cache: true,
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&cache=true&path=%2Ftest&stub=true", expect.anything());
+        expect(result).toEqual("results!");
+    });
     it("uses different base URL", async () => {
         const fetchMock = vi.fn().mockImplementation(() => {
             return {

package/dist/esm/simpleMarkupFetcher.js

@@ -0,0 +1,18 @@
+import { injectSchema } from "./injectSchema";
+import { BASE_URL, fetchFreshMarkup } from "./markupFetcher";
+import { getEnvironment, parseJson } from "./utils";
+export function simpleMarkupFetcher(platform, fetchImplementation = fetch) {
+    return async ({ tz = undefined, path, domain, apiKey, schema, dateFormat, baseUrl = BASE_URL, environment = getEnvironment(), copy = {}, }) => {
+        path = path || "/";
+        const markup = await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment, copy, dateFormat }, fetchImplementation, platform);
+        if (schema) {
+            const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
+            const parsedSchema = parseJson(preparedSchema);
+            if (!parsedSchema) {
+                return markup;
+            }
+            return injectSchema(markup, parsedSchema);
+        }
+        return markup;
+    };
+}

package/dist/esm/simpleMarkupFetcher.test.js

@@ -0,0 +1,266 @@
+import * as injectSchema from "./injectSchema";
+import { describe, expect, it, vi } from "vitest";
+import { simpleMarkupFetcher } from "./simpleMarkupFetcher";
+describe("simpleMarkupFetcher", () => {
+    it("constructs fetch request correctly", async () => {
+        const injectSchemaSpy = vi.spyOn(injectSchema, "injectSchema");
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        const result = await fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+        });
+        expect(injectSchemaSpy).not.toHaveBeenCalled();
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest", expect.objectContaining({
+            headers: expect.objectContaining({
+                Accept: "application/json",
+                Authorization: "Bearer 123abc",
+                "X-Platform": "test",
+            }),
+            method: "GET",
+        }));
+        expect(result).toEqual("results!");
+    });
+    it("stubs comments", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        const result = await fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "development",
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest&stub=true", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("uses different base URL", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("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/v3/markup?domain=test.com&path=%2Ftest", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("respects production!!!", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("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/v3/markup?domain=test.com&path=%2Ftest", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("falls back to root path", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        const result = await fetcher({
+            path: null,
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2F", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("credentials are invalid", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 401,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        expect(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+        })).rejects.toThrowError(/Unauthorized!/);
+    });
+    it("response isn't ok", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        expect(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+        })).rejects.toThrowError(/request failed! Status code: 500/);
+    });
+    it("passes custom copy", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        const result = await fetcher({
+            path: null,
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+            copy: {
+                copy_confirmation_message: "custom confirmation message",
+                copy_submit_button: "custom submit button",
+            },
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2F&copy_confirmation_message=custom+confirmation+message&copy_submit_button=custom+submit+button", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("passes date format string", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        await fetcher({
+            path: null,
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+            dateFormat: "yyyy-MM-dd",
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2F&date_format=yyyy-MM-dd", expect.anything());
+    });
+    it("response isn't ok", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = simpleMarkupFetcher("test", fetchMock);
+        expect(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+        })).rejects.toThrowError(/request failed! Status code: 500/);
+    });
+    describe("copy overrides", () => {
+        it("encodes copy overrides", async () => {
+            const fetchMock = vi.fn().mockImplementation(() => {
+                return {
+                    status: 200,
+                    ok: true,
+                    text: () => "results!",
+                };
+            });
+            const fetcher = simpleMarkupFetcher("test", fetchMock);
+            await fetcher({
+                path: "/some/path",
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+                copy: {
+                    copy_confirmation_message: "custom confirmation message",
+                    copy_submit_button: "custom submit button",
+                },
+            });
+            expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Fsome%2Fpath&copy_confirmation_message=custom+confirmation+message&copy_submit_button=custom+submit+button", expect.anything());
+        });
+    });
+    describe("timezone validation", () => {
+        it("throws error when invalid timezone is provided", async () => {
+            const fetchImplMock = vi.fn();
+            const fetcher = simpleMarkupFetcher("test", fetchImplMock);
+            expect(fetchImplMock).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 = simpleMarkupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/some/path",
+                domain: "test.com",
+                apiKey: "123abc",
+                tz: "America/New_York",
+                environment: "production",
+            });
+            expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Fsome%2Fpath&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 = simpleMarkupFetcher("test", fetchMock);
+            const result = await fetcher({
+                path: "/some/path",
+                domain: "test.com",
+                apiKey: "123abc",
+                tz: "   America/Chicago   ",
+                environment: "production",
+            });
+            expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Fsome%2Fpath&tz=America%2FChicago", expect.anything());
+            expect(result).toEqual("results!");
+        });
+    });
+});

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export type { CustomCopy } from "./markupFetcher";
+export { simpleMarkupFetcher } from "./simpleMarkupFetcher";
 export { markupFetcher, fetchAll } from "./markupFetcher";
 export { removeFalseyValues } from "./utils";
 export { log, logError } from "./log";

package/dist/types/markupFetcher.d.ts

@@ -19,6 +19,7 @@ export interface IFetchData {
     baseUrl?: string;
     environment?: string;
     dateFormat?: string;
+    cache?: boolean;
     copy?: {
         copy_confirmation_message?: string;
         copy_submit_button?: string;
@@ -49,9 +50,10 @@ interface IBatchResponse {
         total: number;
     };
 }
+export declare const BASE_URL = "https://go.jamcomments.com";
 export declare function fetchAll({ tz, dateFormat, domain, apiKey, baseUrl, environment, copy, }: IBatchFetchData, platform: string, fetchImplementation?: any, batchMarkupFetcherImpl?: any, store?: Store): Promise<Map<string, string>>;
 export declare function batchMarkupFetcher(platform: string, fetchImplementation?: typeof fetch): (args: IBatchFetchData) => Promise<IBatchResponse>;
-export declare function fetchFreshMarkup({ tz, path, copy, domain, apiKey, dateFormat, baseUrl, environment, }: IFetchData, fetchImplementation: typeof fetch, platform: string): Promise<string>;
-export declare function makeMarkupRequest<T extends Partial<IBatchFetchData & IFetchData>>({ tz, path, page, domain, apiKey, dateFormat, copy, baseUrl, environment, }: T, baseServicePath: string, fetchImplementation: typeof fetch, platform: string): Promise<Response>;
+export declare function fetchFreshMarkup({ tz, path, copy, cache, domain, apiKey, dateFormat, baseUrl, environment, }: IFetchData, fetchImplementation: typeof fetch, platform: string): Promise<string>;
+export declare function makeMarkupRequest<T extends Partial<IBatchFetchData & IFetchData>>({ tz, path, page, cache, domain, apiKey, dateFormat, copy, baseUrl, environment, }: T, baseServicePath: string, fetchImplementation: typeof fetch, platform: string): Promise<Response>;
 export declare function markupFetcher(platform: string, fetchImplementation?: typeof fetch, store?: Store): (args: IFetchData) => Promise<string>;
 export {};

package/dist/types/simpleMarkupFetcher.d.ts

@@ -0,0 +1,2 @@
+import { IFetchData } from "./markupFetcher";
+export declare function simpleMarkupFetcher(platform: string, fetchImplementation?: typeof fetch): (args: IFetchData) => Promise<string>;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "5.10.2",
+  "version": "5.12.0",
   "description": "Various JavaScript utilities for JamComments.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -22,11 +22,11 @@
   "homepage": "https://jamcomments.com",
   "license": "GPL-2.0",
   "devDependencies": {
-    "@types/node": "^22.9.0",
-    "prettier": "^3.3.3",
-    "typescript": "^5.6.3",
-    "vite": "^5.4.11",
-    "vitest": "^2.1.5"
+    "@types/node": "^22.10.1",
+    "prettier": "^3.4.1",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.1",
+    "vitest": "^2.1.6"
   },
   "publishConfig": {
     "access": "public"