@jam-comments/server-utilities 5.0.0 → 5.2.0

package/dist/cjs/injectSchema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.injectSchema = void 0;
+exports.injectSchema = injectSchema;
 const utils_1 = require("./utils");
 function injectSchema(markup, schema) {
     const commentSchema = markup.match(/<div jc-data="jcSchema" data-schema="(.*)"><\/div>/)?.[1];
@@ -12,4 +12,3 @@ function injectSchema(markup, schema) {
         .replace("<!-- JC:SCHEMA -->", `<script type="application/ld+json">${JSON.stringify(schema)}</script>`)
         .replace(/<div jc-data="jcSchema" data-schema=".*"><\/div>(?:\n+)?/, "");
 }
-exports.injectSchema = injectSchema;

package/dist/cjs/markupFetcher.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.markupFetcher = exports.makeMarkupRequest = exports.fetchFreshMarkup = exports.batchMarkupFetcher = exports.fetchAll = void 0;
+exports.fetchAll = fetchAll;
+exports.batchMarkupFetcher = batchMarkupFetcher;
+exports.fetchFreshMarkup = fetchFreshMarkup;
+exports.makeMarkupRequest = makeMarkupRequest;
+exports.markupFetcher = markupFetcher;
 const injectSchema_1 = require("./injectSchema");
 const utils_1 = require("./utils");
-async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher) {
+async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), copy = {}, }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher) {
     const fetchBatchMarkup = batchMarkupFetcherImpl(platform, fetchImplementation);
     (0, utils_1.createTempDirectory)();
     let shouldKeepFetching = true;
@@ -18,6 +22,7 @@ async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.
                 environment,
                 page,
                 tz,
+                copy,
             });
             console.log(`Checking for comment data. Batch: ${current_page}/${last_page}`);
             const saveMarkupPromises = items.map((item) => {
@@ -37,20 +42,17 @@ async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.
         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 async ({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), page = 1, copy = {}, }) => {
+        const response = await makeMarkupRequest({ tz, domain, apiKey, baseUrl, environment, page, copy }, "/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);
+async function fetchFreshMarkup({ tz = undefined, path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), copy = {}, }, fetchImplementation = fetch, platform) {
+    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment, copy }, "/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) {
+async function makeMarkupRequest({ tz = undefined, path = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), page = undefined, copy = {}, }, 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}`);
@@ -70,6 +72,9 @@ async function makeMarkupRequest({ tz = undefined, path = undefined, domain, api
     if (environment !== "production") {
         params.set("stub", "true");
     }
+    for (const [key, value] of Object.entries(copy)) {
+        params.set(key, value);
+    }
     const requestUrl = `${baseUrl}${baseServicePath}?${params}`;
     const response = await fetchImplementation(requestUrl, {
         method: "GET",
@@ -87,9 +92,8 @@ async function makeMarkupRequest({ tz = undefined, path = undefined, domain, api
     }
     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)(), }) => {
+    return async ({ tz = undefined, path, domain, apiKey, schema, baseUrl = "https://go.jamcomments.com", environment = (0, utils_1.getEnvironment)(), copy = {}, }) => {
         path = path || "/";
         const savedFile = (() => {
             if (!(0, utils_1.tempDirectoryExists)()) {
@@ -99,7 +103,7 @@ function markupFetcher(platform, fetchImplementation = fetch) {
         })();
         const markup = savedFile
             ? savedFile
-            : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment }, fetchImplementation, platform);
+            : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment, copy }, fetchImplementation, platform);
         if (schema) {
             const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
             const parsedSchema = (0, utils_1.parseJson)(preparedSchema);
@@ -111,4 +115,3 @@ function markupFetcher(platform, fetchImplementation = fetch) {
         return markup;
     };
 }
-exports.markupFetcher = markupFetcher;

package/dist/cjs/markupFetcher.test.js

@@ -157,6 +157,50 @@ const { markupFetcher, batchMarkupFetcher } = fetcherExports;
         }
         (0, vitest_1.expect)(deleteTempDirectorySpy).toHaveBeenCalledOnce();
     });
+    vitest_1.it.only("handles copy overrides", 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",
+            copy: {
+                copy_confirmation_message: "custom confirmation message",
+                copy_submit_button: "custom submit button",
+            },
+        }, "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",
+            copy: {
+                copy_confirmation_message: "custom confirmation message",
+                copy_submit_button: "custom submit button",
+            },
+            environment: "production",
+            page: 1,
+            tz: undefined,
+        });
+        (0, vitest_1.expect)(saveFileSpy).toHaveBeenCalledTimes(2);
+    });
 });
 (0, vitest_1.describe)("batchMarkupFetcher", () => {
     (0, vitest_1.it)("constructs fetch request correctly", async () => {
@@ -353,6 +397,43 @@ const { markupFetcher, batchMarkupFetcher } = fetcherExports;
             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 = markupFetcher("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)("response isn't ok", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = markupFetcher("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)("using saved markup", () => {
         (0, vitest_1.it)("makes fresh request when temp directory does not exist", async () => {
             const tempDirectoryExistsSpy = vitest_1.vi
@@ -423,6 +504,29 @@ const { markupFetcher, batchMarkupFetcher } = fetcherExports;
             (0, vitest_1.expect)(result).toEqual("<!-- EMPTY -->");
         });
     });
+    (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 = markupFetcher("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();

package/dist/cjs/utils.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveFile = exports.tempDirectoryExists = exports.getEmptyMarkup = exports.readFile = exports.toSavedFileName = exports.createTempDirectory = exports.deleteTempDirectory = exports.unescapeHTML = exports.parseJson = exports.getEnvironment = exports.isValidTimezone = void 0;
+exports.isValidTimezone = isValidTimezone;
+exports.getEnvironment = getEnvironment;
+exports.parseJson = parseJson;
+exports.unescapeHTML = unescapeHTML;
+exports.deleteTempDirectory = deleteTempDirectory;
+exports.createTempDirectory = createTempDirectory;
+exports.toSavedFileName = toSavedFileName;
+exports.readFile = readFile;
+exports.getEmptyMarkup = getEmptyMarkup;
+exports.tempDirectoryExists = tempDirectoryExists;
+exports.saveFile = saveFile;
 const fs_1 = require("fs");
 const _1 = require(".");
 function isValidTimezone(tz) {
@@ -12,7 +22,6 @@ function isValidTimezone(tz) {
         return false;
     }
 }
-exports.isValidTimezone = isValidTimezone;
 function getEnvironment() {
     if (typeof process === "undefined") {
         return "production";
@@ -21,7 +30,6 @@ function getEnvironment() {
         process.env?.NODE_ENV ||
         "development");
 }
-exports.getEnvironment = getEnvironment;
 function parseJson(json) {
     try {
         return JSON.parse(json);
@@ -30,7 +38,6 @@ function parseJson(json) {
         return null;
     }
 }
-exports.parseJson = parseJson;
 function unescapeHTML(str) {
     var htmlEntities = {
         nbsp: " ",
@@ -62,23 +69,19 @@ 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 (!tempDirectoryExists(existsSyncImpl)) {
         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 {
@@ -88,15 +91,12 @@ function readFile(name, readFileSyncImpl = fs_1.readFileSync) {
         return null;
     }
 }
-exports.readFile = readFile;
 function getEmptyMarkup() {
     return readFile("EMPTY");
 }
-exports.getEmptyMarkup = getEmptyMarkup;
 function tempDirectoryExists(existsSyncImpl = fs_1.existsSync) {
     return existsSyncImpl(_1.TEMP_DIRECTORY);
 }
-exports.tempDirectoryExists = tempDirectoryExists;
 function saveFile(name, data, writeFileImpl = fs_1.writeFile) {
     const fileName = toSavedFileName(name);
     return new Promise((resolve) => {
@@ -105,4 +105,3 @@ function saveFile(name, data, writeFileImpl = fs_1.writeFile) {
         });
     });
 }
-exports.saveFile = saveFile;

package/dist/esm/markupFetcher.js

@@ -1,6 +1,6 @@
 import { injectSchema } from "./injectSchema";
 import { createTempDirectory, deleteTempDirectory, getEmptyMarkup, getEnvironment, isValidTimezone, parseJson, readFile, saveFile, tempDirectoryExists, } from "./utils";
-export async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher) {
+export async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), copy = {}, }, platform, fetchImplementation = fetch, batchMarkupFetcherImpl = batchMarkupFetcher) {
     const fetchBatchMarkup = batchMarkupFetcherImpl(platform, fetchImplementation);
     createTempDirectory();
     let shouldKeepFetching = true;
@@ -15,6 +15,7 @@ export async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "http
                 environment,
                 page,
                 tz,
+                copy,
             });
             console.log(`Checking for comment data. Batch: ${current_page}/${last_page}`);
             const saveMarkupPromises = items.map((item) => {
@@ -35,16 +36,16 @@ export async function fetchAll({ tz = undefined, domain, apiKey, baseUrl = "http
     }
 }
 export function batchMarkupFetcher(platform, fetchImplementation = fetch) {
-    return async ({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), page = 1, }) => {
-        const response = await makeMarkupRequest({ tz, domain, apiKey, baseUrl, environment, page }, "/api/v3/markup/all", fetchImplementation, platform);
+    return async ({ tz = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), page = 1, copy = {}, }) => {
+        const response = await makeMarkupRequest({ tz, domain, apiKey, baseUrl, environment, page, copy }, "/api/v3/markup/all", fetchImplementation, platform);
         return response.json();
     };
 }
-export async function fetchFreshMarkup({ tz = undefined, path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), }, fetchImplementation = fetch, platform) {
-    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment }, "/api/v3/markup", fetchImplementation, platform);
+export async function fetchFreshMarkup({ tz = undefined, path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), copy = {}, }, fetchImplementation = fetch, platform) {
+    const response = await makeMarkupRequest({ tz, path, domain, apiKey, baseUrl, environment, copy }, "/api/v3/markup", fetchImplementation, platform);
     return response.text();
 }
-export async function makeMarkupRequest({ tz = undefined, path = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), page = undefined, }, baseServicePath, fetchImplementation = fetch, platform) {
+export async function makeMarkupRequest({ tz = undefined, path = undefined, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), page = undefined, copy = {}, }, baseServicePath, fetchImplementation = fetch, platform) {
     const trimmedTimezone = tz?.trim();
     if (trimmedTimezone && !isValidTimezone(trimmedTimezone)) {
         throw new Error(`The timezone passed to JamComments is invalid: ${trimmedTimezone}`);
@@ -64,6 +65,9 @@ export async function makeMarkupRequest({ tz = undefined, path = undefined, doma
     if (environment !== "production") {
         params.set("stub", "true");
     }
+    for (const [key, value] of Object.entries(copy)) {
+        params.set(key, value);
+    }
     const requestUrl = `${baseUrl}${baseServicePath}?${params}`;
     const response = await fetchImplementation(requestUrl, {
         method: "GET",
@@ -82,7 +86,7 @@ export async function makeMarkupRequest({ tz = undefined, path = undefined, doma
     return response;
 }
 export function markupFetcher(platform, fetchImplementation = fetch) {
-    return async ({ tz = undefined, path, domain, apiKey, schema, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), }) => {
+    return async ({ tz = undefined, path, domain, apiKey, schema, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), copy = {}, }) => {
         path = path || "/";
         const savedFile = (() => {
             if (!tempDirectoryExists()) {
@@ -92,7 +96,7 @@ export function markupFetcher(platform, fetchImplementation = fetch) {
         })();
         const markup = savedFile
             ? savedFile
-            : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment }, fetchImplementation, platform);
+            : await fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment, copy }, fetchImplementation, platform);
         if (schema) {
             const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
             const parsedSchema = parseJson(preparedSchema);

package/dist/esm/markupFetcher.test.js

@@ -132,6 +132,50 @@ describe("fetchAll()", () => {
         }
         expect(deleteTempDirectorySpy).toHaveBeenCalledOnce();
     });
+    it.only("handles copy overrides", async () => {
+        const saveFileSpy = vi.spyOn(utilsExports, "saveFile");
+        const mockBatchFetcher = 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 = vi.fn().mockImplementation((a, b) => {
+            return mockBatchFetcher;
+        });
+        await fetcherExports.fetchAll({
+            domain: "test.com",
+            apiKey: "123abc",
+            environment: "production",
+            copy: {
+                copy_confirmation_message: "custom confirmation message",
+                copy_submit_button: "custom submit button",
+            },
+        }, "test_platform", vi.fn(), batchMarkupFetcherMock);
+        expect(batchMarkupFetcherMock).toHaveBeenCalledWith("test_platform", expect.anything());
+        expect(mockBatchFetcher).toHaveBeenCalledWith({
+            domain: "test.com",
+            apiKey: "123abc",
+            baseUrl: "https://go.jamcomments.com",
+            copy: {
+                copy_confirmation_message: "custom confirmation message",
+                copy_submit_button: "custom submit button",
+            },
+            environment: "production",
+            page: 1,
+            tz: undefined,
+        });
+        expect(saveFileSpy).toHaveBeenCalledTimes(2);
+    });
 });
 describe("batchMarkupFetcher", () => {
     it("constructs fetch request correctly", async () => {
@@ -328,6 +372,43 @@ describe("markupFetcher", () => {
             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 = markupFetcher("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("response isn't ok", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!",
+            };
+        });
+        const fetcher = markupFetcher("test", fetchMock);
+        expect(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+        })).rejects.toThrowError(/request failed! Status code: 500/);
+    });
     describe("using saved markup", () => {
         it("makes fresh request when temp directory does not exist", async () => {
             const tempDirectoryExistsSpy = vi
@@ -398,6 +479,29 @@ describe("markupFetcher", () => {
             expect(result).toEqual("<!-- EMPTY -->");
         });
     });
+    describe("copy overrides", () => {
+        it("encodes copy overrides", async () => {
+            const fetchMock = vi.fn().mockImplementation(() => {
+                return {
+                    status: 200,
+                    ok: true,
+                    text: () => "results!",
+                };
+            });
+            const fetcher = markupFetcher("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();

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export type { CustomCopy } from "./markupFetcher";
 export declare const TEMP_DIRECTORY: string;
 export { markupFetcher, fetchAll } from "./markupFetcher";
 export { deleteTempDirectory } from "./utils";

package/dist/types/markupFetcher.d.ts

@@ -1,3 +1,14 @@
+export interface CustomCopy {
+    confirmationMessage?: string;
+    submitButton?: string;
+    namePlaceholder?: string;
+    emailPlaceholder?: string;
+    commentPlaceholder?: string;
+    writeTab?: string;
+    previewTab?: string;
+    authButton?: string;
+    logOutButton?: string;
+}
 export interface IFetchData {
     path: string;
     domain: string;
@@ -6,6 +17,17 @@ export interface IFetchData {
     tz?: string;
     baseUrl?: string;
     environment?: string;
+    copy?: {
+        copy_confirmation_message?: string;
+        copy_submit_button?: string;
+        copy_name_placeholder?: string;
+        copy_email_placeholder?: string;
+        copy_comment_placeholder?: string;
+        copy_write_tab?: string;
+        copy_preview_tab?: string;
+        copy_auth_button?: string;
+        copy_log_out_button?: string;
+    };
 }
 export type IBatchFetchData = Omit<IFetchData, "path" | "schema"> & {
     page?: number;
@@ -25,9 +47,9 @@ interface IBatchResponse {
         total: number;
     };
 }
-export declare function fetchAll({ tz, domain, apiKey, baseUrl, environment, }: IBatchFetchData, platform: string, fetchImplementation?: any, batchMarkupFetcherImpl?: any): Promise<void>;
+export declare function fetchAll({ tz, domain, apiKey, baseUrl, environment, copy, }: IBatchFetchData, platform: string, fetchImplementation?: any, batchMarkupFetcherImpl?: any): Promise<void>;
 export declare function batchMarkupFetcher(platform: string, fetchImplementation?: typeof fetch): (args: IBatchFetchData) => Promise<IBatchResponse>;
-export declare function fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment, }: IFetchData, fetchImplementation: typeof fetch, platform: string): Promise<string>;
-export declare function makeMarkupRequest<T extends Partial<IBatchFetchData & IFetchData>>({ tz, path, domain, apiKey, baseUrl, environment, page, }: T, baseServicePath: string, fetchImplementation: typeof fetch, platform: string): Promise<Response>;
+export declare function fetchFreshMarkup({ tz, path, domain, apiKey, baseUrl, environment, copy, }: IFetchData, fetchImplementation: typeof fetch, platform: string): Promise<string>;
+export declare function makeMarkupRequest<T extends Partial<IBatchFetchData & IFetchData>>({ tz, path, domain, apiKey, baseUrl, environment, page, copy, }: T, baseServicePath: string, fetchImplementation: typeof fetch, platform: string): Promise<Response>;
 export declare function markupFetcher(platform: string, fetchImplementation?: typeof fetch): (args: IFetchData) => Promise<string>;
 export {};

package/dist/types/utils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { existsSync, mkdirSync, readFileSync } from "fs";
 export declare function isValidTimezone(tz: string): boolean;
 export declare function getEnvironment(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "5.0.0",
+  "version": "5.2.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": "^20.12.12",
-    "prettier": "^3.2.5",
-    "typescript": "^5.4.5",
-    "vite": "^5.2.11",
-    "vitest": "^1.6.0"
+    "@types/node": "^20.14.11",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.3",
+    "vite": "^5.3.4",
+    "vitest": "^2.0.3"
   },
   "publishConfig": {
     "access": "public"