test: add tests for public interface (#4587)

This adds tests for what’s exposed from packages.
They make it visible when something is accidentally leaked.
Especially because of current `export *` use.
From #4538 (comment)

In a future PR I’d like to add export maps everywhere. That prevents leaking entire files. Then these test cases can be updated to check the paths that are exposed too.

Author: wooorm-arcjet

analyze-wasm/package.json

@@ -54,7 +54,9 @@
     "build": "npm run build:jco && npm run build:rollup",
     "lint": "eslint .",
     "prepublishOnly": "npm run build",
-    "test": "npm run build && npm run lint"
+    "test-api": "node --test",
+    "test-coverage": "node --experimental-test-coverage --test",
+    "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {},
   "devDependencies": {

analyze-wasm/test/index.test.ts

@@ -0,0 +1,10 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+
+test("@arcjet/analyze-wasm", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "initializeWasm",
+    ]);
+  });
+});

analyze/test/analyze.test.ts

@@ -14,6 +14,17 @@ const exampleEmailOptions = {
   requireTopLevelDomain: true,
 };
 
+test("@arcjet/analyze", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "detectBot",
+      "detectSensitiveInfo",
+      "generateFingerprint",
+      "isValidEmail",
+    ]);
+  });
+});
+
 test("detectBot", async function (t) {
   await t.test("should fail w/o user agent", async function () {
     await assert.rejects(

arcjet/package.json

@@ -42,7 +42,6 @@
     "build": "rollup --config rollup.config.js",
     "lint": "eslint .",
     "prepublishOnly": "npm run build",
-    "pretest": "npm run build",
     "test-api": "node --test",
     "test-coverage": "node --experimental-test-coverage --test",
     "test": "npm run build && npm run lint && npm run test-coverage"

arcjet/test/index.test.ts

@@ -0,0 +1,41 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+
+test("arcjet", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "ArcjetAllowDecision",
+      "ArcjetBotReason",
+      "ArcjetChallengeDecision",
+      "ArcjetConclusion",
+      "ArcjetDecision",
+      "ArcjetDenyDecision",
+      "ArcjetEdgeRuleReason",
+      "ArcjetEmailReason",
+      "ArcjetEmailType",
+      "ArcjetErrorDecision",
+      "ArcjetErrorReason",
+      "ArcjetIpDetails",
+      "ArcjetMode",
+      "ArcjetRateLimitAlgorithm",
+      "ArcjetRateLimitReason",
+      "ArcjetReason",
+      "ArcjetRuleResult",
+      "ArcjetRuleState",
+      "ArcjetSensitiveInfoReason",
+      "ArcjetSensitiveInfoType",
+      "ArcjetShieldReason",
+      "ArcjetStack",
+      "botCategories",
+      "default",
+      "detectBot",
+      "fixedWindow",
+      "protectSignup",
+      "sensitiveInfo",
+      "shield",
+      "slidingWindow",
+      "tokenBucket",
+      "validateEmail",
+    ]);
+  });
+});

body/test/body.test.ts

@@ -4,6 +4,14 @@ import * as http from "http";
 import { readBody } from "../index.js";
 import type { AddressInfo } from "net";
 
+test("@arcjet/body", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "readBody",
+    ]);
+  });
+});
+
 describe("reads the body from the readable stream", () => {
   test("should read normal body streams", (t, done) => {
     const server = http.createServer(async (req, res) => {

cache/test/index.test.ts

@@ -0,0 +1,10 @@
+import assert from "node:assert/strict";
+import { test } from "node:test";
+
+test("@arcjet/cache", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "MemoryCache",
+    ]);
+  });
+});

decorate/test/decorate.test.ts

@@ -11,6 +11,14 @@ import { OutgoingMessage } from "http";
 
 function noop() {}
 
+test("@arcjet/decorate", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "setRateLimitHeaders",
+    ]);
+  });
+});
+
 describe("setRateLimitHeaders", () => {
   describe("Header object", () => {
     test("empty results do not set headers", () => {

duration/test/index.test.ts

@@ -2,6 +2,14 @@ import assert from "node:assert/strict";
 import { describe, test } from "node:test";
 import { parse } from "../index.js";
 
+test("@arcjet/duration", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "parse",
+    ]);
+  });
+});
+
 describe("parse", () => {
   test("always returns 0 if the duration string is just 0", () => {
     assert.equal(parse("0"), 0);

env/test/env.test.ts

@@ -2,6 +2,18 @@ import assert from "node:assert/strict";
 import { describe, test } from "node:test";
 import * as env from "../index.ts";
 
+test("@arcjet/env", async function (t) {
+  await t.test("should expose the public api", async function () {
+    assert.deepEqual(Object.keys(await import("../index.js")).sort(), [
+      "apiKey",
+      "baseUrl",
+      "isDevelopment",
+      "logLevel",
+      "platform",
+    ]);
+  });
+});
+
 describe("env", () => {
   test("platform", () => {
     assert.equal(env.platform({}), undefined);