@jam-comments/server-utilities 5.11.0 → 5.12.0

package/dist/cjs/markupFetcher.js

@@ -51,11 +51,11 @@ function batchMarkupFetcher(platform, fetchImplementation = fetch) {
         return response.json();
     };
 }
-async function fetchFreshMarkup({ tz, path, copy, 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 }, "/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 = exports.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}`);
@@ -63,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);
     }
@@ -99,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 = exports.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) {
@@ -109,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

@@ -369,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/esm/markupFetcher.js

@@ -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/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;
@@ -52,7 +53,7 @@ interface IBatchResponse {
 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "description": "Various JavaScript utilities for JamComments.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -22,7 +22,7 @@
   "homepage": "https://jamcomments.com",
   "license": "GPL-2.0",
   "devDependencies": {
-    "@types/node": "^22.10.0",
+    "@types/node": "^22.10.1",
     "prettier": "^3.4.1",
     "typescript": "^5.7.2",
     "vite": "^6.0.1",