@jam-comments/astro 2.5.1 → 2.6.1

package/index.d.ts

@@ -1,3 +1,5 @@
+import { CustomCopy } from "@jam-comments/server-utilities";
+
 declare global {
   interface Window {
     JamComments: {
@@ -14,6 +16,7 @@ export interface JamCommentsProps {
   baseUrl?: string;
   environment?: string;
   tz?: string;
+  copy?: CustomCopy;
 }
 
 export default function JamComments(args: JamCommentsProps): JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/astro",
-  "version": "2.5.1",
+  "version": "2.6.1",
   "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.7.0",
-    "@jam-comments/server-utilities": "^4.3.3",
-    "astro": "^4.8.6",
+    "@astrojs/check": "^0.8.2",
+    "@jam-comments/server-utilities": "^5.2.0",
+    "astro": "^4.11.6",
     "node-fetch": "^3.3.2",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.3"
   },
   "gitHead": "2b1cefb90c89a2f70099213881b09216f20e3dc2",
   "devDependencies": {
-    "@types/node": "^20.12.12",
-    "prettier": "^3.2.5",
-    "prettier-plugin-astro": "^0.13.0",
-    "vitest": "^1.6.0"
+    "@types/node": "^20.14.11",
+    "prettier": "^3.3.3",
+    "prettier-plugin-astro": "^0.14.1",
+    "vitest": "^2.0.3"
   }
 }

package/src/component.astro

@@ -2,7 +2,7 @@
 import pkg from "@jam-comments/server-utilities";
 import nodeFetch from "node-fetch";
 import type { JamCommentsProps } from "..";
-import { getCurrentPath } from "./utils";
+import { getCurrentPath, removeFalseyValues } from "./utils";
 const { logError, markupFetcher } = pkg;
 
 type Props = JamCommentsProps;
@@ -10,6 +10,7 @@ type Props = JamCommentsProps;
 const fetchMarkup = markupFetcher("astro", nodeFetch as any);
 
 async function fetchCommentData({
+  copy,
   tz = undefined,
   path = undefined,
   schema = undefined,
@@ -27,6 +28,17 @@ async function fetchCommentData({
       baseUrl,
       environment,
       tz,
+      copy: removeFalseyValues({
+        copy_confirmation_message: copy.confirmationMessage,
+        copy_submit_button: copy.submitButton,
+        copy_name_placeholder: copy.submitButton,
+        copy_email_placeholder: copy.submitButton,
+        copy_comment_placeholder: copy.submitButton,
+        copy_write_tab: copy.submitButton,
+        copy_preview_tab: copy.submitButton,
+        copy_auth_button: copy.submitButton,
+        copy_log_out_button: copy.submitButton,
+      }),
     });
   } catch (e) {
     logError(e as string);
@@ -34,7 +46,15 @@ async function fetchCommentData({
   }
 }
 
-const { path, domain, baseUrl, environment, tz, schema } = Astro.props as Props;
+const {
+  path,
+  domain,
+  baseUrl,
+  environment,
+  tz,
+  schema,
+  copy = {},
+} = Astro.props as Props;
 
 const markup = await fetchCommentData({
   path: path || getCurrentPath(Astro),
@@ -43,6 +63,7 @@ const markup = await fetchCommentData({
   baseUrl,
   environment,
   tz,
+  copy,
 });
 ---
 

package/src/utils.test.ts

@@ -1,22 +1,48 @@
-import { expect, it } from "vitest";
-import { getCurrentPath } from "./utils";
+import { describe, expect, it } from "vitest";
+import { getCurrentPath, removeFalseyValues } from "./utils";
+import { AstroGlobal } from "astro";
 
-it("should return the current path", () => {
-  const astro = {
-    request: {
-      url: "https://example.com/test",
-    },
-  };
+describe("getCurrentPath()", () => {
+  it("should return the current path", () => {
+    const astro = {
+      request: {
+        url: "https://example.com/test",
+      },
+    } as AstroGlobal;
 
-  expect(getCurrentPath(astro)).toBe("/test");
+    expect(getCurrentPath(astro)).toBe("/test");
+  });
+
+  it("should ignore query parameters", () => {
+    const astro = {
+      request: {
+        url: "https://example.com/test?query=param",
+      },
+    } as AstroGlobal;
+
+    expect(getCurrentPath(astro)).toBe("/test");
+  });
 });
 
-it("should ignore query parameters", () => {
-  const astro = {
-    request: {
-      url: "https://example.com/test?query=param",
-    },
-  };
+describe("removeFalseyValues()", () => {
+  it("should remove falsey values", () => {
+    expect(removeFalseyValues({ a: 1, b: 0, d: null, e: "" })).toEqual({
+      a: 1,
+    });
+  });
+
+  it("should remove undefined items", () => {
+    const customCopy = {
+      copy_confirmation_message: "Thank you for your comment!",
+      copy_submit_button: "Submit",
+      copy_name_placeholder: undefined,
+    };
+
+    const result = removeFalseyValues(customCopy);
 
-  expect(getCurrentPath(astro)).toBe("/test");
+    expect(result).toEqual({
+      copy_confirmation_message: "Thank you for your comment!",
+      copy_submit_button: "Submit",
+    });
+  });
 });

package/src/utils.ts

@@ -1,3 +1,11 @@
-export function getCurrentPath(astro) {
+import { AstroGlobal } from "astro";
+
+export function getCurrentPath(astro: AstroGlobal) {
   return new URL(astro.request.url).pathname;
 }
+
+export function removeFalseyValues<T>(obj: T): Partial<T> {
+  const filteredItems = Object.entries(obj).filter(([, value]) => value);
+
+  return Object.fromEntries(filteredItems) as Partial<T>;
+}