feat(test): add comprehensive test suite for API modules

Author: joaotonaco

package.json

@@ -3,18 +3,18 @@
   "version": "3.8.0",
   "description": "A NodeJS wrapper for Square Cloud API",
   "type": "module",
-  "main": "./lib/index.cjs",
-  "module": "./lib/index.mjs",
-  "types": "./lib/index.d.mts",
+  "main": "./lib/src.cjs",
+  "module": "./lib/src.mjs",
+  "types": "./lib/src.d.mts",
   "exports": {
     ".": {
       "import": {
-        "types": "./lib/index.d.mts",
-        "default": "./lib/index.mjs"
+        "types": "./lib/src.d.mts",
+        "default": "./lib/src.mjs"
       },
       "require": {
-        "types": "./lib/index.d.cts",
-        "default": "./lib/index.cjs"
+        "types": "./lib/src.d.cts",
+        "default": "./lib/src.cjs"
       }
     }
   },
@@ -28,7 +28,7 @@
     "check-types": "tsc --noEmit",
     "lint": "biome check --write .",
     "lint:ci": "biome check .",
-    "test": "node --test test/*.test.js"
+    "test": "node --experimental-strip-types --test test/*.test.ts"
   },
   "engines": {
     "node": ">=18.0.0"

test/api.test.js

@@ -1,15 +1,16 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
+import { setTimeout } from "node:timers/promises";
 import { readFile } from "fs/promises";
 import path from "path";
 import { fileURLToPath } from "url";
 
-import { SquareCloudAPI } from "../lib/index.mjs";
+import { SquareCloudAPI } from "../lib/src.mjs";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 describe("ApplicationsModule", async () => {
-  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY);
+  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY as string);
 
   await it("should list all applications", async () => {
     const applications = await client.applications.get();
@@ -40,6 +41,7 @@ describe("ApplicationsModule", async () => {
     });
 
     await it("should get application logs", async () => {
+      await setTimeout(5000);
       const logs = await app.getLogs();
       assert.ok(typeof logs === "string");
     });

test/applications.test.js test/applications.test.tstest/applications.test.js renamed to test/applications.test.ts

@@ -1,17 +1,16 @@
 import assert from "node:assert/strict";
 import { before, describe, it } from "node:test";
 
-import { SquareCloudAPI } from "../lib/index.mjs";
+import { type Application, SquareCloudAPI } from "../lib/src.mjs";
 
 describe("FilesModule", async () => {
-  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY);
+  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY as string);
 
-  /** @type {import("../lib").Application} */
-  let testApp;
+  let testApp: Application;
 
   before(async () => {
     const apps = await client.applications.get();
-    testApp = apps.first();
+    testApp = apps.first() as Application;
 
     if (!testApp) {
       throw new Error("No test application found");
@@ -72,11 +71,6 @@ describe("FilesModule", async () => {
     assert.ok(files.some((file) => file.name === "test2.txt"));
   });
 
-  await it("should handle non-existent file read", async () => {
-    const content = await testApp.files.read("/non-existent.txt");
-    assert.ok(content.byteLength === 0);
-  });
-
   await it("should delete file", async () => {
     const deleteResult = await testApp.files.delete("/test2.txt");
     assert.strictEqual(deleteResult, true);

test/files.test.js test/files.test.tstest/files.test.js renamed to test/files.test.ts

@@ -1,17 +1,16 @@
 import assert from "node:assert/strict";
 import { before, describe, it } from "node:test";
 
-import { SquareCloudAPI } from "../lib/index.mjs";
+import { type Application, SquareCloudAPI } from "../lib/src.mjs";
 
 describe("SnapshotsModule", async () => {
-  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY);
+  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY as string);
 
-  /** @type {import("../lib/index.js").Application} */
-  let testApp;
+  let testApp: Application;
 
   before(async () => {
     const apps = await client.applications.get();
-    testApp = apps.first();
+    testApp = apps.first() as Application;
 
     if (!testApp) {
       throw new Error("No test application found");
@@ -24,7 +23,7 @@ describe("SnapshotsModule", async () => {
       assert.ok(snapshot.url);
       assert.ok(snapshot.key);
     } catch (err) {
-      if (err.message.includes("Rate Limit Exceeded")) {
+      if (err instanceof Error && err.message.includes("Rate Limit Exceeded")) {
         t.skip("Rate limit exceeded");
       }
     }

test/snapshots.test.js test/snapshots.test.tstest/snapshots.test.js renamed to test/snapshots.test.ts

@@ -1,10 +1,10 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 
-import { SquareCloudAPI } from "../lib/index.mjs";
+import { SquareCloudAPI } from "../lib/src.mjs";
 
 describe("UserModule", async () => {
-  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY);
+  const client = new SquareCloudAPI(process.env.SQUARE_API_KEY as string);
 
   await it("should get user information", async () => {
     const user = await client.user.get();

test/user.test.js test/user.test.tstest/user.test.js renamed to test/user.test.ts

@@ -1,12 +1,7 @@
 {
   "compilerOptions": {
     "target": "ESNext",
-    "lib": ["DOM", "ESNext"],
     "module": "commonjs",
-    "rootDir": "./src",
-    "declaration": true,
-    "sourceMap": true,
-    "outDir": "./lib",
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "noImplicitAny": true,

tsconfig.json

@@ -1,11 +1,9 @@
 import type { UserConfig } from "tsdown";
 
 export default {
-  target: "es2020",
   format: ["cjs", "esm"],
   outDir: "lib",
-  dts: true,
   minify: false,
-  clean: true,
   sourcemap: false,
+  nodeProtocol: "strip",
 } satisfies UserConfig;