@jam-comments/server-utilities 1.0.5 → 2.0.0

package/dist/cjs/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markupFetcher = exports.logError = exports.log = void 0;
+const markupFetcher_1 = require("./markupFetcher");
+Object.defineProperty(exports, "markupFetcher", { enumerable: true, get: function () { return markupFetcher_1.markupFetcher; } });
+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/log.js

@@ -0,0 +1,15 @@
+"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 = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const log = (message) => {
+    console.log(`${chalk_1.default.magenta("JamComments:")} ${message}`);
+};
+exports.log = log;
+const logError = (message) => {
+    console.error(`JamComments: ${message}`);
+};
+exports.logError = logError;

package/dist/cjs/markupFetcher.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markupFetcher = void 0;
+const markupFetcher = (platform, fetchImplementation = fetch) => {
+    return async ({ path, domain, apiKey, baseUrl = 'https://go.jamcomments.com', environment = 'production' }) => {
+        const params = new URLSearchParams({
+            path: path || "/",
+            domain
+        });
+        if (environment !== 'production') {
+            params.set('stub', 'true');
+        }
+        const requestUrl = `${baseUrl}/api/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}`);
+        }
+        return await response.text();
+    };
+};
+exports.markupFetcher = markupFetcher;

package/dist/cjs/markupFetcher.test.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const markupFetcher_1 = require("./markupFetcher");
+(0, vitest_1.describe)("markupFetcher", () => {
+    (0, vitest_1.it)("constructs fetch request correctly", 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"
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/markup?path=%2Ftest&domain=test.com", vitest_1.expect.objectContaining({
+            headers: vitest_1.expect.objectContaining({
+                Accept: "application/json",
+                Authorization: "Bearer 123abc",
+                "X-Platform": "test"
+            }),
+            method: "GET"
+        }));
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("stubs comments", 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",
+            environment: "development"
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/markup?path=%2Ftest&domain=test.com&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 {
+                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",
+            baseUrl: "http://ur-mom.com"
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/markup?path=%2Ftest&domain=test.com", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("falls back to root path", 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: null,
+            domain: "test.com"
+        });
+        (0, vitest_1.expect)(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/markup?path=%2F&domain=test.com", vitest_1.expect.anything());
+        (0, vitest_1.expect)(result).toEqual("results!");
+    });
+    (0, vitest_1.it)("credentials are invalid", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 401,
+                ok: false,
+                text: () => "bad results!"
+            };
+        });
+        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        (0, vitest_1.expect)(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc"
+        })).rejects.toThrowError(/Unauthorized!/);
+    });
+    (0, vitest_1.it)("response isn't ok", async () => {
+        const fetchMock = vitest_1.vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!"
+            };
+        });
+        const fetcher = (0, markupFetcher_1.markupFetcher)("test", fetchMock);
+        (0, vitest_1.expect)(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc"
+        })).rejects.toThrowError(/request failed! Status code: 500/);
+    });
+});

package/dist/esm/log.js

@@ -0,0 +1,7 @@
+import chalk from "chalk";
+export const log = (message) => {
+    console.log(`${chalk.magenta("JamComments:")} ${message}`);
+};
+export const logError = (message) => {
+    console.error(`JamComments: ${message}`);
+};

package/dist/esm/markupFetcher.js

@@ -0,0 +1,27 @@
+export const markupFetcher = (platform, fetchImplementation = fetch) => {
+    return async ({ path, domain, apiKey, baseUrl = 'https://go.jamcomments.com', environment = 'production' }) => {
+        const params = new URLSearchParams({
+            path: path || "/",
+            domain
+        });
+        if (environment !== 'production') {
+            params.set('stub', 'true');
+        }
+        const requestUrl = `${baseUrl}/api/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}`);
+        }
+        return await response.text();
+    };
+};

package/dist/esm/markupFetcher.test.js

@@ -0,0 +1,110 @@
+import { describe, expect, it, vi } from 'vitest';
+import { markupFetcher } from "./markupFetcher";
+describe("markupFetcher", () => {
+    it("constructs fetch request correctly", 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"
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/markup?path=%2Ftest&domain=test.com", expect.objectContaining({
+            headers: expect.objectContaining({
+                Accept: "application/json",
+                Authorization: "Bearer 123abc",
+                "X-Platform": "test"
+            }),
+            method: "GET"
+        }));
+        expect(result).toEqual("results!");
+    });
+    it("stubs comments", 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"
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/markup?path=%2Ftest&domain=test.com&stub=true", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("uses different base URL", 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",
+            baseUrl: "http://ur-mom.com"
+        });
+        expect(fetchMock).toHaveBeenCalledWith("http://ur-mom.com/api/markup?path=%2Ftest&domain=test.com", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("falls back to root path", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 200,
+                ok: true,
+                text: () => "results!"
+            };
+        });
+        const fetcher = markupFetcher("test", fetchMock);
+        const result = await fetcher({
+            path: null,
+            domain: "test.com"
+        });
+        expect(fetchMock).toHaveBeenCalledWith("https://go.jamcomments.com/api/markup?path=%2F&domain=test.com", expect.anything());
+        expect(result).toEqual("results!");
+    });
+    it("credentials are invalid", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 401,
+                ok: false,
+                text: () => "bad results!"
+            };
+        });
+        const fetcher = markupFetcher("test", fetchMock);
+        expect(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc"
+        })).rejects.toThrowError(/Unauthorized!/);
+    });
+    it("response isn't ok", async () => {
+        const fetchMock = vi.fn().mockImplementation(() => {
+            return {
+                status: 500,
+                ok: false,
+                text: () => "bad results!"
+            };
+        });
+        const fetcher = markupFetcher("test", fetchMock);
+        expect(fetcher({
+            path: "/test",
+            domain: "test.com",
+            apiKey: "123abc"
+        })).rejects.toThrowError(/request failed! Status code: 500/);
+    });
+});

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+import { markupFetcher } from "./markupFetcher";
+export { log, logError } from "./log";
+export { markupFetcher };

package/dist/types/markupFetcher.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,22 +1,23 @@
 {
   "name": "@jam-comments/server-utilities",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "Various JavaScript utilities for JamComments.",
-  "main": "dist/index.umd.js",
-  "module": "dist/index.es.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
   "files": [
     "dist/"
   ],
   "exports": {
-    "import": "./dist/index.es.js",
-    "require": "./dist/index.umd.js"
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js"
   },
   "scripts": {
     "watch": "npm run build -- --watch",
-    "build": "vite build && tsc",
-    "test": "echo 'No tests here...'",
-    "prettify": "prettier ./**/*.{js,md,ts} --write",
+    "build": "rm -rf dist && npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc --module es2020 --outDir dist/esm",
+    "build:cjs": "tsc --module commonjs --outDir dist/cjs",
+    "test": "vitest run src",
     "prepare": "npm run build"
   },
   "keywords": [],
@@ -24,19 +25,15 @@
   "homepage": "https://jamcomments.com",
   "license": "GPL-2.0",
   "dependencies": {
-    "@jam-comments/server-utilities": "^1.0.5",
-    "@jam-comments/shared-utilities": "^0.0.4",
-    "graphql-quest": "^1.1.2",
-    "typescript": "^4.9.3",
-    "url-parse": "^1.5.10"
+    "typescript": "^4.9.3"
   },
   "devDependencies": {
     "@types/node": "^18.11.9",
     "prettier": "^2.7.1",
-    "vite": "^3.2.4"
+    "vite": "^3.2.4",
+    "vitest": "^0.25.3"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "94d1edbe4bf2e543bd9ddce05bc1106e69d88c1e"
+  }
 }