@jam-comments/server-utilities 4.2.0 → 4.3.0

package/dist/cjs/index.js

@@ -1,10 +1,17 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logError = exports.log = exports.reAppendMarkup = exports.markupFetcher = void 0;
+exports.logError = exports.log = exports.deleteTempDirectory = exports.reAppendMarkup = exports.fetchAll = exports.markupFetcher = exports.TEMP_DIRECTORY = void 0;
+const path_1 = __importDefault(require("path"));
+exports.TEMP_DIRECTORY = path_1.default.join(process.cwd(), "_temp_jc");
 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; } });
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "reAppendMarkup", { enumerable: true, get: function () { return utils_1.reAppendMarkup; } });
+Object.defineProperty(exports, "deleteTempDirectory", { enumerable: true, get: function () { return utils_1.deleteTempDirectory; } });
 var log_1 = require("./log");
 Object.defineProperty(exports, "log", { enumerable: true, get: function () { return log_1.log; } });
 Object.defineProperty(exports, "logError", { enumerable: true, get: function () { return log_1.logError; } });

package/dist/cjs/markupFetcher.js

@@ -1,40 +1,100 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.markupFetcher = void 0;
+exports.markupFetcher = exports.makeMarkupRequest = exports.fetchFreshMarkup = exports.batchMarkupFetcher = exports.fetchAll = void 0;
 const injectSchema_1 = require("./injectSchema");
 const utils_1 = require("./utils");
-const markupFetcher = (platform, fetchImplementation = fetch) => {
-    return async ({ tz = undefined, path, domain, apiKey, schema, 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");
-        }
-        const requestUrl = `${baseUrl}/api/v3/markup?${params}`;
-        const response = await fetchImplementation(requestUrl, {
-            method: "GET",
-            headers: {
-                Authorization: `Bearer ${apiKey}`,
-                Accept: "application/json",
-                "X-Platform": platform,
-            },
-        });
-        if (response.status === 401) {
-            throw new Error(`Unauthorized! Are your domain and JamComments API key set correctly?`);
-        }
-        if (!response.ok) {
-            throw new Error(`JamComments request failed! Status code: ${response.status}, message: ${response.statusText}, request URL: ${requestUrl}`);
+async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), }, platform, fetchImplementation, batchMarkupFetcherImpl = batchMarkupFetcher) {
+    const fetchBatchMarkup = batchMarkupFetcherImpl(platform, fetchImplementation);
+    (0, utils_1.createTempDirectory)();
+    let shouldKeepFetching = true;
+    let page = 1;
+    console.log("Fetching comments from JamComments! This might take a sec.");
+    try {
+        while (shouldKeepFetching) {
+            const { data: items, meta: { current_page, last_page }, } = await fetchBatchMarkup({
+                domain,
+                apiKey,
+                baseUrl,
+                environment,
+                page,
+                tz,
+            });
+            console.log(`Checking for comment data. Batch: ${current_page}/${last_page}`);
+            const saveMarkupPromises = items.map((item) => {
+                return (0, utils_1.saveFile)(item.path, item.markup);
+            });
+            await Promise.all(saveMarkupPromises);
+            if (current_page === last_page) {
+                shouldKeepFetching = false;
+            }
+            else {
+                page++;
+            }
         }
-        const markup = await response.text();
+    }
+    catch (error) {
+        (0, utils_1.deleteTempDirectory)();
+        throw error;
+    }
+}
+exports.fetchAll = fetchAll;
+function batchMarkupFetcher(platform, fetchImplementation = fetch) {
+    return async ({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), page = 1, }) => {
+        const response = await makeMarkupRequest({ tz, domain, apiKey, baseUrl, environment, page }, "/api/v3/markup/all", fetchImplementation, platform);
+        return response.json();
+    };
+}
+exports.batchMarkupFetcher = batchMarkupFetcher;
+async function fetchFreshMarkup({ tz = undefined, path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), }, fetchImplementation = fetch, platform) {
+    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment }, "/api/v3/markup", fetchImplementation, platform);
+    return response.text();
+}
+exports.fetchFreshMarkup = fetchFreshMarkup;
+async function makeMarkupRequest({ tz = undefined, path = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), page = undefined, }, 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}`);
+    }
+    const params = new URLSearchParams({
+        domain,
+    });
+    if (path) {
+        params.set("path", path);
+    }
+    if (page) {
+        params.set("page", page.toString());
+    }
+    if (trimmedTimezone) {
+        params.set("tz", trimmedTimezone);
+    }
+    if (environment !== "production") {
+        params.set("stub", "true");
+    }
+    const requestUrl = `${baseUrl}${baseServicePath}?${params}`;
+    const response = await fetchImplementation(requestUrl, {
+        method: "GET",
+        headers: {
+            Authorization: `Bearer ${apiKey}`,
+            Accept: "application/json",
+            "X-Platform": platform,
+        },
+    });
+    if (response.status === 401) {
+        throw new Error(`Unauthorized! Are your domain and JamComments API key set correctly?`);
+    }
+    if (!response.ok) {
+        throw new Error(`JamComments request failed! Status code: ${response.status}, message: ${response.statusText}, request URL: ${requestUrl}`);
+    }
+    return response;
+}
+exports.makeMarkupRequest = makeMarkupRequest;
+function markupFetcher(platform, fetchImplementation = fetch) {
+    return async ({ tz = undefined, path, domain, apiKey, schema, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), }) => {
+        path = path || "/";
+        const savedFile = (0, utils_1.readFile)(path);
+        const markup = savedFile
+            ? savedFile
+            : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment }, fetchImplementation, platform);
         if (schema) {
             const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
             const parsedSchema = (0, utils_1.parseJson)(preparedSchema);
@@ -45,5 +105,5 @@ const markupFetcher = (platform, fetchImplementation = fetch) => {
         }
         return markup;
     };
-};
+}
 exports.markupFetcher = markupFetcher;

package/dist/cjs/markupFetcher.test.js

@@ -25,7 +25,202 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const vitest_1 = require("vitest");
 const injectSchema = __importStar(require("./injectSchema"));
-const markupFetcher_1 = require("./markupFetcher");
+const fetcherExports = __importStar(require("./markupFetcher"));
+const node_test_1 = require("node:test");
+const utilsExports = __importStar(require("./utils"));
+const { deleteTempDirectory } = utilsExports;
+const { markupFetcher, batchMarkupFetcher } = fetcherExports;
+(0, vitest_1.beforeEach)(() => {
+    deleteTempDirectory();
+});
+(0, node_test_1.afterEach)(() => {
+    vitest_1.vi.resetAllMocks();
+});
+(0, vitest_1.describe)("fetchAll()", () => {
+    (0, vitest_1.it)("fetches all comments in a single request", async () => {
+        const saveFileSpy = vitest_1.vi.spyOn(utilsExports, "saveFile");
+        const mockBatchFetcher = vitest_1.vi.fn().mockReturnValue({
+            data: [
+                { path: "/test", markup: "markup1" },
+                { path: "/test2", markup: "markup2" },
+            ],
+            meta: {
+                current_page: 1,
+                from: 1,
+                last_page: 1,
+                path: "/test",
+                per_page: 10,
+                to: 2,
+                total: 2,
+            },
+        });
+        const batchMarkupFetcherMock = vitest_1.vi.fn().mockImplementation((a, b) => {
+            return mockBatchFetcher;
+        });
+        await fetcherExports.fetchAll({
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+        }, "test_platform", vitest_1.vi.fn(), batchMarkupFetcherMock);
+        (0, vitest_1.expect)(batchMarkupFetcherMock).toHaveBeenCalledWith("test_platform", vitest_1.expect.anything());
+        (0, vitest_1.expect)(mockBatchFetcher).toHaveBeenCalledWith({
+            domain: "test.com",
+            apiKey: "123abc",
+            baseUrl: "https://go.jamcomments.com",
+            environment: "production",
+            page: 1,
+            tz: undefined,
+        });
+        (0, vitest_1.expect)(saveFileSpy).toHaveBeenCalledTimes(2);
+        (0, vitest_1.expect)(saveFileSpy).toHaveBeenCalledWith("/test", "markup1");
+        (0, vitest_1.expect)(saveFileSpy).toHaveBeenCalledWith("/test2", "markup2");
+    });
+    (0, vitest_1.it)("fetches all comments in multiple requests", async () => {
+        const saveFileSpy = vitest_1.vi.spyOn(utilsExports, "saveFile");
+        const mockBatchFetcher = vitest_1.vi
+            .fn()
+            .mockReturnValueOnce({
+            data: [
+                { path: "/test", markup: "markup1" },
+                { path: "/test2", markup: "markup2" },
+            ],
+            meta: {
+                current_page: 1,
+                from: 1,
+                last_page: 2,
+                path: "/test",
+                per_page: 2,
+                to: 2,
+            },
+        })
+            .mockReturnValueOnce({
+            data: [
+                { path: "/test3", markup: "markup3" },
+                { path: "/test4", markup: "markup4" },
+            ],
+            meta: {
+                current_page: 2,
+                from: 3,
+                last_page: 2,
+                path: "/test",
+                per_page: 2,
+                to: 4,
+            },
+        });
+        const batchMarkupFetcherMock = vitest_1.vi.fn().mockImplementation((a, b) => {
+            return mockBatchFetcher;
+        });
+        await fetcherExports.fetchAll({
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+        }, "test_platform", vitest_1.vi.fn(), batchMarkupFetcherMock);
+        (0, vitest_1.expect)(batchMarkupFetcherMock).toHaveBeenCalledWith("test_platform", vitest_1.expect.anything());
+        (0, vitest_1.expect)(mockBatchFetcher).toHaveBeenCalledWith({
+            domain: "test.com",
+            apiKey: "123abc",
+            baseUrl: "https://go.jamcomments.com",
+            environment: "production",
+            page: 1,
+            tz: undefined,
+        });
+        (0, vitest_1.expect)(mockBatchFetcher).toHaveBeenCalledTimes(2);
+        (0, vitest_1.expect)(mockBatchFetcher).toHaveBeenCalledWith({
+            domain: "test.com",
+            apiKey: "123abc",
+            baseUrl: "https://go.jamcomments.com",
+            environment: "production",
+            page: 2,
+            tz: undefined,
+        });
+        (0, vitest_1.expect)(saveFileSpy).toHaveBeenCalledTimes(4);
+        (0, vitest_1.expect)(saveFileSpy).toHaveBeenCalledWith("/test", "markup1");
+        (0, vitest_1.expect)(saveFileSpy).toHaveBeenCalledWith("/test2", "markup2");
+    });
+    (0, vitest_1.it)("deletes the temp directory of anything fails", async () => {
+        const deleteTempDirectorySpy = vitest_1.vi.spyOn(utilsExports, "deleteTempDirectory");
+        const mockBatchFetcher = vitest_1.vi.fn().mockImplementation(() => {
+            throw new Error("test error");
+        });
+        const batchMarkupFetcherMock = vitest_1.vi.fn().mockImplementation((a, b) => {
+            return mockBatchFetcher;
+        });
+        try {
+            await fetcherExports.fetchAll({
+                domain: "test.com",
+                apiKey: "123abc",
+                environment: "production",
+            }, "test_platform", vitest_1.vi.fn(), batchMarkupFetcherMock);
+        }
+        catch (e) {
+            (0, vitest_1.expect)(e.message).toEqual("test error");
+        }
+        (0, vitest_1.expect)(deleteTempDirectorySpy).toHaveBeenCalledOnce();
+    });
+});
+(0, vitest_1.describe)("batchMarkupFetcher", () => {
+    (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,
+                json: () => "results!",
+            };
+        });
+        const fetcher = batchMarkupFetcher("test", fetchMock);
+        const result = await fetcher({
+            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/all?domain=test.com&page=1", 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,
+                json: () => "results!",
+            };
+        });
+        const fetcher = batchMarkupFetcher("test", fetchMock);
+        const result = await fetcher({
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "development",
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup/all?domain=test.com&page=1&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,
+                json: () => "results!",
+            };
+        });
+        const fetcher = batchMarkupFetcher("test", fetchMock);
+        const result = await fetcher({
+            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/all?domain=test.com&page=1", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+});
 (0, vitest_1.describe)("markupFetcher", () => {
     (0, vitest_1.it)("constructs fetch request correctly", async () => {
         const injectSchemaSpy = vitest_1.vi.spyOn(injectSchema, "injectSchema");
@@ -36,7 +231,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         const result = await fetcher({
             path: "/test",
             domain: "test.com",
@@ -44,7 +239,7 @@ const markupFetcher_1 = require("./markupFetcher");
             environment: "production",
         });
         (0, vitest_1.expect)(injectSchemaSpy).not.toHaveBeenCalled();
-        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com", vitest_1.expect.objectContaining({
+        (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",
@@ -62,14 +257,14 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("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?path=%2Ftest&domain=test.com&stub=true", vitest_1.expect.anything());
+        (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 () => {
@@ -80,7 +275,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         const result = await fetcher({
             path: "/test",
             domain: "test.com",
@@ -88,7 +283,7 @@ const markupFetcher_1 = require("./markupFetcher");
             baseUrl: "http://ur-mom.com",
             environment: "production",
         });
-        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/v3/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
+        (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 () => {
@@ -99,7 +294,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         const result = await fetcher({
             path: "/test",
             domain: "test.com",
@@ -107,7 +302,7 @@ const markupFetcher_1 = require("./markupFetcher");
             baseUrl: "http://ur-mom.com",
             environment: "production",
         });
-        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/v3/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
+        (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 () => {
@@ -118,14 +313,14 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("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?path=%2F&domain=test.com", vitest_1.expect.anything());
+        (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 () => {
@@ -136,7 +331,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "bad results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         (0, vitest_1.expect)(fetcher({
             path: "/test",
             domain: "test.com",
@@ -151,7 +346,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "bad results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         (0, vitest_1.expect)(fetcher({
             path: "/test",
             domain: "test.com",
@@ -160,9 +355,9 @@ const markupFetcher_1 = require("./markupFetcher");
     });
     (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();
+            const fetchImplMock = vitest_1.vi.fn();
+            const fetcher = markupFetcher("test", fetchImplMock);
+            (0, vitest_1.expect)(fetchImplMock).not.toHaveBeenCalled();
             (0, vitest_1.expect)(fetcher({
                 path: "/test",
                 domain: "test.com",
@@ -179,15 +374,15 @@ const markupFetcher_1 = require("./markupFetcher");
                     text: () => "results!",
                 };
             });
-            const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+            const fetcher = markupFetcher("test", fetchMock);
             const result = await fetcher({
-                path: null,
+                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?path=%2F&domain=test.com&tz=America%2FNew_York", vitest_1.expect.anything());
+            (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 () => {
@@ -198,15 +393,15 @@ const markupFetcher_1 = require("./markupFetcher");
                     text: () => "results!",
                 };
             });
-            const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+            const fetcher = markupFetcher("test", fetchMock);
             const result = await fetcher({
-                path: null,
+                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?path=%2F&domain=test.com&tz=America%2FChicago", vitest_1.expect.anything());
+            (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!");
         });
     });
@@ -221,7 +416,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         const result = await fetcher({
             path: "/test",
             domain: "test.com",
@@ -230,7 +425,7 @@ const markupFetcher_1 = require("./markupFetcher");
             environment: "production",
         });
         (0, vitest_1.expect)(injectSchemaSpy).toHaveBeenCalledWith("results!", { foo: "bar" });
-        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest", vitest_1.expect.anything());
         (0, vitest_1.expect)(result).toEqual("results!");
     });
     (0, vitest_1.it)("does not stringify schema if given a string", async () => {
@@ -242,7 +437,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         const result = await fetcher({
             path: "/test",
             domain: "test.com",
@@ -251,7 +446,7 @@ const markupFetcher_1 = require("./markupFetcher");
             environment: "production",
         });
         (0, vitest_1.expect)(injectSchemaSpy).toHaveBeenCalledWith("results!", { foo: "bar" });
-        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest", vitest_1.expect.anything());
         (0, vitest_1.expect)(result).toEqual("results!");
     });
     (0, vitest_1.it)("returns markup if invalid json is provided", async () => {
@@ -263,7 +458,7 @@ const markupFetcher_1 = require("./markupFetcher");
                 text: () => "results!",
             };
         });
-        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const fetcher = markupFetcher("test", fetchMock);
         const result = await fetcher({
             path: "/test",
             domain: "test.com",
@@ -272,7 +467,7 @@ const markupFetcher_1 = require("./markupFetcher");
             environment: "production",
         });
         (0, vitest_1.expect)(injectSchemaSpy).not.toHaveBeenCalled();
-        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?domain=test.com&path=%2Ftest", vitest_1.expect.anything());
         (0, vitest_1.expect)(result).toEqual("results!");
     });
 });

package/dist/cjs/utils.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unescapeHTML = exports.parseJson = exports.reAppendMarkup = exports.getEnvironment = exports.isValidTimezone = void 0;
+exports.saveFile = exports.readFile = exports.toSavedFileName = exports.createTempDirectory = exports.deleteTempDirectory = exports.unescapeHTML = exports.parseJson = exports.reAppendMarkup = exports.getEnvironment = exports.isValidTimezone = void 0;
+const fs_1 = require("fs");
+const _1 = require(".");
 function isValidTimezone(tz) {
     try {
         Intl.DateTimeFormat(undefined, { timeZone: tz });
@@ -37,21 +39,21 @@ function parseJson(json) {
     }
 }
 exports.parseJson = parseJson;
-var htmlEntities = {
-    nbsp: " ",
-    cent: "¢",
-    pound: "£",
-    yen: "¥",
-    euro: "€",
-    copy: "©",
-    reg: "®",
-    lt: "<",
-    gt: ">",
-    quot: '"',
-    amp: "&",
-    apos: "'",
-};
 function unescapeHTML(str) {
+    var htmlEntities = {
+        nbsp: " ",
+        cent: "¢",
+        pound: "£",
+        yen: "¥",
+        euro: "€",
+        copy: "©",
+        reg: "®",
+        lt: "<",
+        gt: ">",
+        quot: '"',
+        amp: "&",
+        apos: "'",
+    };
     return str.replace(/\&([^;]+);/g, function (entity, entityCode) {
         var match;
         if (entityCode in htmlEntities) {
@@ -69,3 +71,38 @@ function unescapeHTML(str) {
     });
 }
 exports.unescapeHTML = unescapeHTML;
+function deleteTempDirectory() {
+    if ((0, fs_1.existsSync)(_1.TEMP_DIRECTORY)) {
+        (0, fs_1.rmdirSync)(_1.TEMP_DIRECTORY, { recursive: true });
+    }
+}
+exports.deleteTempDirectory = deleteTempDirectory;
+function createTempDirectory(mkdirSyncImpl = fs_1.mkdirSync, existsSyncImpl = fs_1.existsSync) {
+    if (!existsSyncImpl(_1.TEMP_DIRECTORY)) {
+        mkdirSyncImpl(_1.TEMP_DIRECTORY);
+    }
+}
+exports.createTempDirectory = createTempDirectory;
+function toSavedFileName(name) {
+    return name.replace(/^\//, "").replace(/\//g, "::");
+}
+exports.toSavedFileName = toSavedFileName;
+function readFile(name, readFileSyncImpl = fs_1.readFileSync) {
+    const fileName = toSavedFileName(name);
+    try {
+        return readFileSyncImpl(`${_1.TEMP_DIRECTORY}/${fileName}`, "utf8");
+    }
+    catch (error) {
+        return null;
+    }
+}
+exports.readFile = readFile;
+function saveFile(name, data, writeFileImpl = fs_1.writeFile) {
+    const fileName = toSavedFileName(name);
+    return new Promise((resolve) => {
+        writeFileImpl(`${_1.TEMP_DIRECTORY}/${fileName}`, data, () => {
+            resolve();
+        });
+    });
+}
+exports.saveFile = saveFile;