{"id":18239,"library":"configurapi-test-utils","title":"Configurapi Test Utils","description":"Helper utilities for testing Configurapi handlers. v1.0.5 ships TypeScript types, but the package is very new and may have limited documentation. Offers base test classes and mocks for Configurapi environments. Currently stable with no known breaking changes, but the API may evolve. Differentiator: purpose-built for Configurapi, reducing boilerplate in integration tests.","status":"active","version":"1.0.5","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","typescript"],"install":[{"cmd":"npm install configurapi-test-utils","lang":"bash","label":"npm"},{"cmd":"yarn add configurapi-test-utils","lang":"bash","label":"yarn"},{"cmd":"pnpm add configurapi-test-utils","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"This is a named export, not a default export.","wrong":"import TestHandler from 'configurapi-test-utils'","symbol":"TestHandler","correct":"import { TestHandler } from 'configurapi-test-utils'"},{"note":"Package is ESM-only; require() will fail unless using dynamic import.","wrong":"const { MockRequest } = require('configurapi-test-utils')","symbol":"MockRequest","correct":"import { MockRequest } from 'configurapi-test-utils'"},{"note":"MockResponse is a type, so use 'import type' when only using as a type.","wrong":"import { MockResponse } from 'configurapi-test-utils'","symbol":"MockResponse","correct":"import type { MockResponse } from 'configurapi-test-utils'"}],"quickstart":{"code":"import { TestHandler, MockRequest, MockResponse } from 'configurapi-test-utils';\nimport { handler } from './my-handler';\n\nconst req = new MockRequest({\n  method: 'GET',\n  path: '/items',\n  query: { limit: '10' },\n  headers: { 'content-type': 'application/json' },\n  body: null\n});\n\nconst res = new MockResponse();\n\nTestHandler.run(handler, req, res).then(() => {\n  console.log(res.statusCode); // 200\n  console.log(res.body); // response body\n});","lang":"typescript","description":"Demonstrates using MockRequest and MockResponse to test a Configurapi handler in TypeScript."},"warnings":[{"fix":"Use dynamic import() or configure your project to use ESM.","message":"Package is ESM-only. CommonJS require() will throw an error.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Cast body to expected type or use toJSON() if available.","message":"MockResponse.body might not be a string; check type definitions.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Ensure handler is async or returns a Promise.","message":"TestHandler.run() expects async handler; wrapping non-async handler may cause issues.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Add 'type': 'module' to your package.json or use .mjs extension for the importing file.","cause":"Trying to import the package in a CommonJS file without 'type': 'module'.","error":"SyntaxError: Cannot use import statement outside a module"},{"fix":"Use import { MockRequest } from 'configurapi-test-utils'.","cause":"Using default import instead of named import.","error":"TypeError: MockRequest is not a constructor"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}