@jam-comments/server-utilities 4.1.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/injectSchema.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.injectSchema = void 0;
+const utils_1 = require("./utils");
+function injectSchema(markup, schema) {
+    const commentSchema = markup.match(/<div jc-data="jcSchema" data-schema="(.*)"><\/div>/)?.[1];
+    if (!commentSchema) {
+        return markup;
+    }
+    const json = (0, utils_1.parseJson)((0, utils_1.unescapeHTML)(commentSchema));
+    if (!json) {
+        return markup;
+    }
+    schema.comment = json;
+    return markup
+        .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/injectSchema.test.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const injectSchema_1 = require("./injectSchema");
+(0, vitest_1.it)("injects schema into markup", () => {
+    const markup = `
+<div id="jcComments">
+    <div jc-data="jcSchema" data-schema="[{&quot;@context&quot;:&quot;https:\/\/schema.org&quot;,&quot;@type&quot;:&quot;Comment&quot;,&quot;name&quot;:&quot;Alexis&quot;,&quot;dateCreated&quot;:&quot;2022-10-28T10:41:49+00:00&quot;,&quot;url&quot;:&quot;https:\/\/macarthur.me\/posts\/dynamic-routing#comment-133&quot;}]"></div>
+
+<!-- JC:SCHEMA -->
+</div>`;
+    const blogPostSchema = {
+        "@context": "http://schema.org",
+        "@type": "BlogPosting",
+    };
+    const result = (0, injectSchema_1.injectSchema)(markup, blogPostSchema);
+    (0, vitest_1.expect)(result).toEqual(`
+<div id="jcComments">
+    <script type="application/ld+json">{"@context":"http://schema.org","@type":"BlogPosting","comment":[{"@context":"https://schema.org","@type":"Comment","name":"Alexis","dateCreated":"2022-10-28T10:41:49+00:00","url":"https://macarthur.me/posts/dynamic-routing#comment-133"}]}</script>
+</div>`);
+});
+(0, vitest_1.it)("returns markup if schema is not found", () => {
+    const markup = `
+<div id="jcComments">
+<!-- JC:SCHEMA -->
+</div>`;
+    const blogPostSchema = {
+        "@context": "http://schema.org",
+        "@type": "BlogPosting",
+    };
+    const result = (0, injectSchema_1.injectSchema)(markup, blogPostSchema);
+    (0, vitest_1.expect)(result).toEqual(markup);
+});
+(0, vitest_1.it)("returns markup if schema is not valid JSON", () => {
+    const markup = `
+<div id="jcComments">
+    <div jc-data="jcSchema" data-schema="not-valid-json"></div>
+    <!-- JC:SCHEMA -->
+</div>`;
+    const blogPostSchema = {
+        "@context": "http://schema.org",
+        "@type": "BlogPosting",
+    };
+    const result = (0, injectSchema_1.injectSchema)(markup, blogPostSchema);
+    (0, vitest_1.expect)(result).toEqual(markup);
+});
+(0, vitest_1.it)("injects even when JSON is not HTML-encoded", () => {
+    const markup = `
+<div id="jcComments">
+    <div jc-data="jcSchema" data-schema="[{"@context":"https://schema.org","@type":"Comment","name":"Alexis","dateCreated":"2022-10-28T10:41:49+00:00","url":"https://macarthur.me/posts/dynamic-routing#comment-133"}]"></div>
+
+<!-- JC:SCHEMA -->
+</div>`;
+    const blogPostSchema = {
+        "@context": "http://schema.org",
+        "@type": "BlogPosting",
+    };
+    const result = (0, injectSchema_1.injectSchema)(markup, blogPostSchema);
+    (0, vitest_1.expect)(result).toEqual(`
+<div id="jcComments">
+    <script type="application/ld+json">{"@context":"http://schema.org","@type":"BlogPosting","comment":[{"@context":"https://schema.org","@type":"Comment","name":"Alexis","dateCreated":"2022-10-28T10:41:49+00:00","url":"https://macarthur.me/posts/dynamic-routing#comment-133"}]}</script>
+</div>`);
+});

package/dist/cjs/markupFetcher.js

@@ -1,43 +1,109 @@
 "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}`);
+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 params = new URLSearchParams({
-            path: path || "/",
-            domain,
-        });
+    }
+    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;
-            params.set("schema", preparedSchema);
-        }
-        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}`);
+            const parsedSchema = (0, utils_1.parseJson)(preparedSchema);
+            if (!parsedSchema) {
+                return markup;
+            }
+            return (0, injectSchema_1.injectSchema)(markup, parsedSchema);
         }
-        return await response.text();
+        return markup;
     };
-};
+}
 exports.markupFetcher = markupFetcher;