@jam-comments/astro 2.6.2 → 2.8.0

package/index.d.ts

@@ -14,6 +14,7 @@ export interface JamCommentsProps {
   domain?: string;
   apiKey?: string;
   baseUrl?: string;
+  dateFormat?: string;
   environment?: string;
   tz?: string;
   copy?: CustomCopy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/astro",
-  "version": "2.6.2",
+  "version": "2.8.0",
   "author": "Alex MacArthur <alex@macarthur.me> (https://macarthur.me)",
   "license": "GPL-2.0",
   "description": "Easily add performant, SEO-friendly comments to your Astro blog with JamComments.",
@@ -38,17 +38,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@astrojs/check": "^0.8.2",
-    "@jam-comments/server-utilities": "^5.2.0",
-    "astro": "^4.12.2",
+    "@astrojs/check": "^0.9.3",
+    "@jam-comments/server-utilities": "^5.10.0",
+    "astro": "^4.15.1",
     "node-fetch": "^3.3.2",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.4"
   },
   "gitHead": "2b1cefb90c89a2f70099213881b09216f20e3dc2",
   "devDependencies": {
-    "@types/node": "^20.14.11",
+    "@types/node": "^22.5.1",
     "prettier": "^3.3.3",
     "prettier-plugin-astro": "^0.14.1",
-    "vitest": "^2.0.3"
+    "vitest": "^2.0.5"
   }
 }

package/src/component.astro

@@ -1,70 +1,37 @@
 ---
-import pkg from "@jam-comments/server-utilities";
-import nodeFetch from "node-fetch";
 import type { JamCommentsProps } from "..";
-import { getCurrentPath, removeFalseyValues } from "./utils";
-const { logError, markupFetcher } = pkg;
+import { fetchCommentData, getCurrentPath } from "./utils";
+import { Store } from "@jam-comments/server-utilities";
 
 type Props = JamCommentsProps;
 
-const fetchMarkup = markupFetcher("astro", nodeFetch as any);
-
-async function fetchCommentData({
-  copy,
-  tz = undefined,
-  path = undefined,
-  schema = undefined,
-  domain = import.meta.env.JAM_COMMENTS_DOMAIN as string,
-  apiKey = import.meta.env.JAM_COMMENTS_API_KEY as string,
-  baseUrl = import.meta.env.JAM_COMMENTS_BASE_URL as string,
-  environment = import.meta.env.JAM_COMMENTS_ENVIRONMENT as string,
-}: JamCommentsProps) {
-  try {
-    return await fetchMarkup({
-      path,
-      schema,
-      domain,
-      apiKey,
-      baseUrl,
-      environment,
-      tz,
-      copy: removeFalseyValues({
-        copy_confirmation_message: copy.confirmationMessage,
-        copy_submit_button: copy.submitButton,
-        copy_name_placeholder: copy.namePlaceholder,
-        copy_email_placeholder: copy.emailPlaceholder,
-        copy_comment_placeholder: copy.commentPlaceholder,
-        copy_write_tab: copy.writeTab,
-        copy_preview_tab: copy.previewTab,
-        copy_auth_button: copy.authButton,
-        copy_log_out_button: copy.logOutButton,
-      }),
-    });
-  } catch (e) {
-    logError(e as string);
-    return null;
-  }
-}
-
 const {
+  tz,
   path,
+  schema,
   domain,
   baseUrl,
+  dateFormat,
   environment,
-  tz,
-  schema,
   copy = {},
 } = Astro.props as Props;
 
-const markup = await fetchCommentData({
-  path: path || getCurrentPath(Astro),
-  schema,
-  domain,
-  baseUrl,
-  environment,
-  tz,
-  copy,
-});
+const store = new Store();
+const pagePath = path || getCurrentPath(Astro);
+const cachedMarkup = store.get(pagePath) || store.emptyMarkup;
+
+const markup =
+  cachedMarkup ||
+  (await fetchCommentData({
+    tz,
+    copy,
+    path: pagePath,
+    schema,
+    domain,
+    baseUrl,
+    environment,
+    dateFormat,
+  }));
 ---
 
 <div set:html={markup} />

package/src/config.ts

@@ -7,6 +7,8 @@ interface PluginArgs {
   environment?: string;
 }
 
+globalThis.jamCommentsStore = new Map<string, string>();
+
 export function jamComments({
   domain,
   apiKey,
@@ -16,8 +18,8 @@ export function jamComments({
   return {
     name: "jamcomments",
     hooks: {
-      "astro:build:start": () => {
-        return fetchAll(
+      "astro:build:start": async () => {
+        globalThis.jamCommentsStore = await fetchAll(
           {
             tz: timezone,
             domain,
@@ -30,7 +32,7 @@ export function jamComments({
       },
 
       "astro:build:done": () => {
-        // deleteTempDirectory();
+        globalThis.jamCommentsStore.clear();
       },
     },
   };

package/src/env.d.ts

@@ -1 +1,2 @@
+/// <reference path="../.astro/types.d.ts" />
 /// <reference types="astro/client" />

package/src/utils.test.ts

@@ -1,5 +1,5 @@
-import { describe, expect, it } from "vitest";
-import { getCurrentPath, removeFalseyValues } from "./utils";
+import { describe, expect, it, vi } from "vitest";
+import { fetchCommentData, getCurrentPath, removeFalseyValues } from "./utils";
 import { AstroGlobal } from "astro";
 
 describe("getCurrentPath()", () => {
@@ -46,3 +46,62 @@ describe("removeFalseyValues()", () => {
     });
   });
 });
+
+describe("fetchCommentData()", () => {
+  it("passes the correct arguments to fetchMarkup", async () => {
+    const mockResponse = vi.fn();
+    const fetchMock = vi.fn().mockImplementation(() => mockResponse);
+
+    const result = await fetchCommentData(
+      {
+        copy: {
+          confirmationMessage: "my confirmation message",
+        },
+        apiKey: "123",
+        dateFormat: "YYYY-MM-DD",
+        path: "/test",
+        domain: "example.com",
+        environment: "production",
+        baseUrl: "https://example.com",
+      },
+      fetchMock,
+    );
+
+    expect(fetchMock).toHaveBeenCalledWith({
+      copy: {
+        copy_confirmation_message: "my confirmation message",
+      },
+      apiKey: "123",
+      dateFormat: "YYYY-MM-DD",
+      path: "/test",
+      domain: "example.com",
+      environment: "production",
+      baseUrl: "https://example.com",
+    });
+
+    expect(result).toBe(mockResponse);
+  });
+
+  it("returns null if fetchMarkup throws an error", async () => {
+    const fetchMock = vi.fn().mockImplementation(() => {
+      throw new Error("test error");
+    });
+
+    const result = await fetchCommentData(
+      {
+        copy: {
+          confirmationMessage: "my confirmation message",
+        },
+        apiKey: "123",
+        path: "/test",
+        domain: "example.com",
+        dateFormat: "YYYY-MM-DD",
+        environment: "production",
+        baseUrl: "https://example.com",
+      },
+      fetchMock,
+    );
+
+    expect(result).toBeNull();
+  });
+});

package/src/utils.ts

@@ -1,4 +1,7 @@
+// import nodeFetch from "node-fetch";
 import { AstroGlobal } from "astro";
+import { JamCommentsProps } from "..";
+import { logError, markupFetcher } from "@jam-comments/server-utilities";
 
 export function getCurrentPath(astro: AstroGlobal) {
   return new URL(astro.request.url).pathname;
@@ -9,3 +12,47 @@ export function removeFalseyValues<T>(obj: T): Partial<T> {
 
   return Object.fromEntries(filteredItems) as Partial<T>;
 }
+
+const fetchMarkup = markupFetcher("astro");
+
+export async function fetchCommentData(
+  {
+    copy,
+    tz = undefined,
+    path = undefined,
+    schema = undefined,
+    dateFormat = undefined,
+    domain = import.meta.env.JAM_COMMENTS_DOMAIN as string,
+    apiKey = import.meta.env.JAM_COMMENTS_API_KEY as string,
+    baseUrl = import.meta.env.JAM_COMMENTS_BASE_URL as string,
+    environment = import.meta.env.JAM_COMMENTS_ENVIRONMENT as string,
+  }: JamCommentsProps,
+  fetchFunc = fetchMarkup,
+) {
+  try {
+    return fetchFunc({
+      path,
+      schema,
+      domain,
+      apiKey,
+      baseUrl,
+      environment,
+      dateFormat,
+      tz,
+      copy: removeFalseyValues({
+        copy_confirmation_message: copy.confirmationMessage,
+        copy_submit_button: copy.submitButton,
+        copy_name_placeholder: copy.namePlaceholder,
+        copy_email_placeholder: copy.emailPlaceholder,
+        copy_comment_placeholder: copy.commentPlaceholder,
+        copy_write_tab: copy.writeTab,
+        copy_preview_tab: copy.previewTab,
+        copy_auth_button: copy.authButton,
+        copy_log_out_button: copy.logOutButton,
+      }),
+    });
+  } catch (e) {
+    logError(e as string);
+    return null;
+  }
+}