@jam-comments/server-utilities 4.0.1 → 4.1.0

package/dist/cjs/markupFetcher.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.markupFetcher = void 0;
 const utils_1 = require("./utils");
 const markupFetcher = (platform, fetchImplementation = fetch) => {
-    return async ({ tz = undefined, path, domain, apiKey, 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)(), }) => {
         const trimmedTimezone = tz?.trim();
         if (trimmedTimezone && !(0, utils_1.isValidTimezone)(trimmedTimezone)) {
             throw new Error(`The timezone passed to JamComments is invalid: ${trimmedTimezone}`);
@@ -12,6 +12,10 @@ const markupFetcher = (platform, fetchImplementation = fetch) => {
             path: path || "/",
             domain,
         });
+        if (schema) {
+            const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
+            params.set("schema", preparedSchema);
+        }
         if (trimmedTimezone) {
             params.set("tz", trimmedTimezone);
         }

package/dist/cjs/markupFetcher.test.js

@@ -185,3 +185,43 @@ const markupFetcher_1 = require("./markupFetcher");
         });
     });
 });
+(0, vitest_1.describe)("passing schema", function () {
+    (0, vitest_1.it)("first stringifies schema if given an object", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const result = await fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            schema: { foo: "bar" },
+            environment: "production",
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com&schema=%7B%22foo%22%3A%22bar%22%7D", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("does not stringify schema if given a string", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!",
+            };
+        });
+        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        const result = await fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc",
+            schema: '{"foo":"bar"}',
+            environment: "production",
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com&schema=%7B%22foo%22%3A%22bar%22%7D", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+});

package/dist/cjs/utils.js

@@ -15,7 +15,9 @@ function getEnvironment() {
     if (typeof process === "undefined") {
         return "production";
     }
-    return (process.env?.JAM_COMMENTS_ENV || process.env?.NODE_ENV || "development");
+    return (process.env?.JAM_COMMENTS_ENVIRONMENT ||
+        process.env?.NODE_ENV ||
+        "development");
 }
 exports.getEnvironment = getEnvironment;
 function reAppendMarkup(element, markup) {

package/dist/cjs/utils.test.js

@@ -24,22 +24,22 @@ const env = process.env;
             (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("production");
         });
     });
-    (0, vitest_1.describe)("JAM_COMMENTS_ENV is set", () => {
+    (0, vitest_1.describe)("JAM_COMMENTS_ENVIRONMENT is set", () => {
         (0, vitest_1.it)("returns environment", () => {
-            process.env.JAM_COMMENTS_ENV = "staging";
+            process.env.JAM_COMMENTS_ENVIRONMENT = "staging";
             (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("staging");
         });
         (0, vitest_1.it)("falls back to NODE_ENV", () => {
-            process.env.JAM_COMMENTS_ENV = undefined;
+            process.env.JAM_COMMENTS_ENVIRONMENT = undefined;
             (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("test");
         });
         (0, vitest_1.it)("falls back to development", () => {
-            process.env.JAM_COMMENTS_ENV = undefined;
+            process.env.JAM_COMMENTS_ENVIRONMENT = undefined;
             process.env.NODE_ENV = undefined;
             (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("development");
         });
         (0, vitest_1.it)("returns production environment", () => {
-            process.env.JAM_COMMENTS_ENV = "production";
+            process.env.JAM_COMMENTS_ENVIRONMENT = "production";
             (0, vitest_1.expect)((0, utils_1.getEnvironment)()).toEqual("production");
         });
     });

package/dist/esm/markupFetcher.js

@@ -1,6 +1,6 @@
 import { getEnvironment, isValidTimezone } from "./utils";
 export const markupFetcher = (platform, fetchImplementation = fetch) => {
-    return async ({ tz = undefined, path, domain, apiKey, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), }) => {
+    return async ({ tz = undefined, path, domain, apiKey, schema, baseUrl = "https://go.jamcomments.com", environment = getEnvironment(), }) => {
         const trimmedTimezone = tz?.trim();
         if (trimmedTimezone && !isValidTimezone(trimmedTimezone)) {
             throw new Error(`The timezone passed to JamComments is invalid: ${trimmedTimezone}`);
@@ -9,6 +9,10 @@ export const markupFetcher = (platform, fetchImplementation = fetch) => {
             path: path || "/",
             domain,
         });
+        if (schema) {
+            const preparedSchema = typeof schema !== "string" ? JSON.stringify(schema) : schema;
+            params.set("schema", preparedSchema);
+        }
         if (trimmedTimezone) {
             params.set("tz", trimmedTimezone);
         }

package/dist/esm/markupFetcher.test.js

@@ -183,3 +183,43 @@ describe("markupFetcher", () => {
         });
     });
 });
+describe("passing schema", function () {
+    it("first stringifies schema if given an object", 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",
+            schema: { foo: "bar" },
+            environment: "production",
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com&schema=%7B%22foo%22%3A%22bar%22%7D", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("does not stringify schema if given a string", 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",
+            schema: '{"foo":"bar"}',
+            environment: "production",
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/v3/markup?path=%2Ftest&domain=test.com&schema=%7B%22foo%22%3A%22bar%22%7D", expect.anything());
+        expect(result).toEqual("results!");
+    });
+});

package/dist/esm/utils.js

@@ -11,7 +11,9 @@ export function getEnvironment() {
     if (typeof process === "undefined") {
         return "production";
     }
-    return (process.env?.JAM_COMMENTS_ENV || process.env?.NODE_ENV || "development");
+    return (process.env?.JAM_COMMENTS_ENVIRONMENT ||
+        process.env?.NODE_ENV ||
+        "development");
 }
 export function reAppendMarkup(element, markup) {
     const range = document.createRange();

package/dist/esm/utils.test.js

@@ -22,22 +22,22 @@ describe("getEnvironment()", () => {
             expect(getEnvironment()).toEqual("production");
         });
     });
-    describe("JAM_COMMENTS_ENV is set", () => {
+    describe("JAM_COMMENTS_ENVIRONMENT is set", () => {
         it("returns environment", () => {
-            process.env.JAM_COMMENTS_ENV = "staging";
+            process.env.JAM_COMMENTS_ENVIRONMENT = "staging";
             expect(getEnvironment()).toEqual("staging");
         });
         it("falls back to NODE_ENV", () => {
-            process.env.JAM_COMMENTS_ENV = undefined;
+            process.env.JAM_COMMENTS_ENVIRONMENT = undefined;
             expect(getEnvironment()).toEqual("test");
         });
         it("falls back to development", () => {
-            process.env.JAM_COMMENTS_ENV = undefined;
+            process.env.JAM_COMMENTS_ENVIRONMENT = undefined;
             process.env.NODE_ENV = undefined;
             expect(getEnvironment()).toEqual("development");
         });
         it("returns production environment", () => {
-            process.env.JAM_COMMENTS_ENV = "production";
+            process.env.JAM_COMMENTS_ENVIRONMENT = "production";
             expect(getEnvironment()).toEqual("production");
         });
     });

package/dist/types/markupFetcher.d.ts

@@ -2,8 +2,9 @@ export interface IFetchData {
     path: string;
     domain: string;
     apiKey: string;
+    schema?: string | object;
     tz?: string;
     baseUrl?: string;
     environment?: string;
 }
-export declare const markupFetcher: (platform: string, fetchImplementation?: typeof fetch) => (args: IFetchData) => Promise<string>;
+export declare const markupFetcher: (platform: string, fetchImplementation?: typeof fetch) => ((args: IFetchData) => Promise<string>);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Various JavaScript utilities for JamComments.",
   "main": "dist/cjs/index.js",
   "types": "dist/types/index.d.ts",
@@ -21,11 +21,11 @@
   "homepage": "https://jamcomments.com",
   "license": "GPL-2.0",
   "devDependencies": {
-    "@types/node": "^20.9.0",
-    "prettier": "^3.0.3",
-    "typescript": "^5.2.2",
-    "vite": "^4.5.0",
-    "vitest": "^0.34.6"
+    "@types/node": "^20.12.11",
+    "prettier": "^3.2.5",
+    "typescript": "^5.4.5",
+    "vite": "^5.2.11",
+    "vitest": "^1.6.0"
   },
   "publishConfig": {
     "access": "public"