@pokujs/dom

Shared DOM testing core for Poku framework adapters.

---

@pokujs/dom centralizes cross-framework testing infrastructure used by adapter libraries such as @pokujs/react and @pokujs/vue.

Use this package when building or maintaining framework adapters that need:

• Runtime command injection for Node, Bun, and Deno.
• In-process test environment setup.
• Metrics normalization and reporting.
• happy-dom/jsdom environment bootstrap.
• Shared testing runtime primitives.

Installation

npm i @pokujs/dom

Usage

1) Build runtime option prefixes and parse flags

import {
  createRuntimeOptionArgPrefixes,
  parseRuntimeOptions,
} from '@pokujs/dom';

const prefixes = createRuntimeOptionArgPrefixes('poku-react');
const runtimeOptions = parseRuntimeOptions(prefixes);

2) Create a framework plugin factory

import {
  createFrameworkTestingPluginFactory,
  type FrameworkDescriptor,
} from '@pokujs/dom';

const descriptor: FrameworkDescriptor = {
  pluginName: 'react-testing',
  packageTag: '@pokujs/react',
  runtimeArgBase: 'poku-react',
  metricMessageType: 'POKU_REACT_RENDER_METRIC',
  metricBatchMessageType: 'POKU_REACT_RENDER_METRIC_BATCH',
};

const { createTestingPlugin } = createFrameworkTestingPluginFactory(
  descriptor,
  import.meta.url
);

export const createReactTestingPlugin = createTestingPlugin;

3) Reuse DOM setup helpers

import { setupHappyDomEnvironment, setupJsdomEnvironment } from '@pokujs/dom';

4) Reuse shared testing runtime helpers

import {
  createRenderMetricsEmitter,
  createScreen,
  getNow,
} from '@pokujs/dom';

Contracts

Adapter packages should follow these contracts.

FrameworkDescriptor contract

• pluginName: Plugin registration name.
• packageTag: Human-readable package tag for messages.
• runtimeArgBase: Prefix base used to generate runtime CLI flags.
• metricMessageType: IPC type for single render metrics.
• metricBatchMessageType: IPC type for batch render metrics.
• testFileExtensions (optional): Test file extensions the runner should intercept.

Runtime options contract

parseRuntimeOptions returns:

• domUrl: DOM URL used by happy-dom/jsdom setup.
• metricsEnabled: Whether metrics collection is active.
• minMetricMs: Drop metrics below this threshold.
• metricBatchSize: Batch size before immediate flush.
• metricFlushMs: Flush interval while buffering.

Metrics contract

createMetricsSummary returns either null or:

• totalCaptured: Number of collected metrics.
• totalReported: Number of top metrics reported.
• topSlowest: Sorted metrics by duration descending.

Testing runtime contract

createRenderMetricsEmitter provides:

• emitRenderMetric(componentName, durationMs)
• flushMetricBuffer()
• clearMetricFlushTimer()

These APIs are framework-agnostic. Adapter packages remain responsible for framework-specific semantics such as act, nextTick, render lifecycle, and hook/composable harness behavior.

Release and CI/CD

This package includes:

• CI build and lint workflows.
• Node, Bun, and Deno compatibility workflows.
• CodeQL workflow and config.
• Release Please + npm publish workflow.

Development

npm ci
npm run check
npm run build

Testing

npm test
npm run test:bun
npm run test:deno

License

MIT