@roku-sdk/device-test-client 2.18.0 → 2.19.0

package/support/paths.ts

@@ -0,0 +1,13 @@
+// Copyright (c) 2026 Roku, Inc.
+// SPDX-License-Identifier: MIT
+
+/**
+ * `@roku-sdk/device-test-client/support/paths`: where a test run writes its artifacts.
+ *
+ * Multi-device runners and Jest global setup use these to agree on the `test-results/`
+ * directory. Like `./support/constants`, this entry point imports only Node built-ins, so a
+ * CommonJS-mode config loader can import it at parse time. It must stay free of `RkClient` and
+ * `@roku-sdk/tooling`.
+ */
+
+export { TEST_RESULTS_DIR_ENV_VAR, TEST_RESULTS_DIR_NAME, defaultTestResultsDir } from "../src/paths";

package/internal/constants.ts

@@ -1,54 +0,0 @@
-// Copyright (c) 2026 Roku, Inc.
-// SPDX-License-Identifier: MIT
-
-/**
- * `@roku-sdk/device-test-client/internal/constants` — config-load-safe
- * entry point for the small subset of `src/constants.ts` symbols that
- * Jest configs (and other CommonJS-mode loaders) legitimately need at
- * **parse time**.
- *
- * Why this exists, and why the public barrel is not enough:
- *
- *   `src/index.ts` re-exports `RkClient` from `src/client/client.ts`,
- *   which imports `@roku-sdk/tooling/src/device-test-helpers.ts`. The
- *   `@roku-sdk/tooling` package declares `"type": "module"` and uses
- *   `import.meta.url`. Loaders that parse `*.config.ts` in CommonJS
- *   mode (ts-node default, esbuild-register, the loader Jest invokes
- *   from `jest-config/readConfigFileAndSetRootDir`) blow up on the
- *   first hop with `ERR_REQUIRE_ESM` — *before* any test, hook, or
- *   transform runs. The stack trace points at the loader, not at the
- *   import that pulled the ESM file in, so the failure is opaque to
- *   the reader of `jest.config.ts`.
- *
- *   `src/constants.ts` itself has only `type` imports (all erased by
- *   TypeScript) and value-level constants, so a file that imports
- *   exclusively from it is parse-safe under CJS. This subpath is the
- *   one sanctioned "deep import past the barrel" surface for that
- *   purpose.
- *
- * Why a re-export shim instead of a direct entry in `exports`:
- *   `device-tests/tsconfig.json` uses `moduleResolution: "Node"`
- *   (classic), which falls back to a filesystem walk and does NOT honor
- *   the package `exports` map. A physical file at this path resolves
- *   under every resolution mode; the `exports` map entry covers the
- *   publish-time / `Node16` / `Bundler` case symmetrically. The same
- *   pattern is used by `./internal/deploy`.
- *
- * SemVer / stability contract:
- *   Symbols here are reachable, typed, and stable across patch releases
- *   — but explicitly NOT covered by SemVer (`/internal/` in the path is
- *   the tell). Partner code MUST NOT import from this subpath; the
- *   public, SemVer-covered surface for these constants stays
- *   `@roku-sdk/device-test-client` (curated barrel in `src/index.ts`).
- *
- * Adding new symbols:
- *   Only constants that a config-loader truly needs at parse time
- *   belong here (file-name constants, env-var names, default budgets
- *   referenced by `jest.config.ts` reporters / global setup). Pure-
- *   implementation magic numbers stay file-internal in
- *   `src/constants.ts`. Prefer extending this barrel over minting a
- *   parallel `/internal/<other>` subpath — keeps the internal contract
- *   grep-able.
- */
-
-export { ARTIFACT_FILE } from "../src/constants";

package/internal/deploy.ts

@@ -1,60 +0,0 @@
-// Copyright (c) 2026 Roku, Inc.
-// SPDX-License-Identifier: MIT
-
-/**
- * `@roku-sdk/device-test-client/internal/deploy` — explicit internal
- * subpath for the **deploy-side** tooling helpers that the curated
- * public API intentionally does NOT carry.
- *
- * Currently exposes:
- *
- *   - `resolveAppPath` — integration-test deploy-guard directory-wipe
- *     path resolution.
- *   - `invalidateBuildCacheForApp` — release the in-process
- *     `RkClient.buildAndDeploy` build memoisation entries scoped to
- *     a single `absRoot`. Pairs with the deploy-guard's
- *     `wipeIntegrationBuildOutput` so a "we rebuilt because the
- *     previous bundle was dirty" recovery path also invalidates the
- *     "we already built this" memoisation. Both calls must run in
- *     lockstep; calling one without the other is a bug.
- *
- * Symbols here are reachable, typed, and stable across patch
- * releases — but explicitly NOT covered by SemVer (`/internal/` in
- * the path is the tell). Partner code MUST NOT import from this
- * subpath; downstream consumers should treat it as private.
- *
- * Why a re-export shim instead of a direct entry in `exports`:
- * `device-tests/tsconfig.json` uses `moduleResolution: "Node"`
- * (classic), which falls back to a filesystem walk and does NOT honor
- * the package `exports` map. A physical file at this path resolves
- * under every resolution mode; the `exports` map entry covers the
- * publish-time / `Node16` / `Bundler` case symmetrically.
- *
- * Adding new symbols (load-chain caveat):
- *   This barrel re-exports from `../src/client/deploy`, which imports
- *   `@roku-sdk/tooling/src/device-test-helpers` — an ESM module
- *   (`"type": "module"`, `import.meta.url`). Anything importing this
- *   subpath therefore pulls that ESM chain in transitively. That is
- *   FINE for runtime callers (Jest transforms `@roku-sdk/*` via babel,
- *   see `device-tests/jest.config.ts → transform`) but it is FATAL
- *   for parse-time loaders such as ts-node in CJS mode that the IDE
- *   and Jest itself use to read `*.config.ts`; those crash with
- *   `ERR_REQUIRE_ESM` before any transform runs.
- *
- *   Group new `@internal` symbols by **load-time safety**, not just
- *   by concern:
- *     - Runtime-only helpers (need the live client / build pipeline /
- *       tooling shim) → add here.
- *     - Symbols a `*.config.ts` legitimately reads at parse time →
- *       add to `./internal/constants` (or another sibling subpath
- *       whose source file imports only types and value-level
- *       literals). Re-confirm by tracing the new file's imports to
- *       leaves; one accidental hop into `@roku-sdk/tooling` re-breaks
- *       the config-loader path.
- *
- *   Prefer extending an existing `/internal/<name>` subpath over
- *   minting a parallel one — keeps the internal contract grep-able.
- */
-
-export { resolveAppPath } from "../src/client/deploy";
-export { invalidateBuildCacheForApp } from "../src/client/build-cache";

package/internal/paths.ts

@@ -1,15 +0,0 @@
-// Copyright (c) 2026 Roku, Inc.
-// SPDX-License-Identifier: MIT
-
-/**
- * `@roku-sdk/device-test-client/internal/paths` — explicit internal
- * subpath for load-safe path constants/helpers used by test config and
- * setup code.
- *
- * This subpath intentionally re-exports only from `src/paths.ts`, whose
- * runtime imports are Node built-ins. It is safe for CommonJS-mode config
- * loaders (`jest.config.ts`, ts-node) and must stay free of `RkClient`,
- * `@roku-sdk/tooling`, or other ESM-heavy runtime chains.
- */
-
-export { TEST_RESULTS_DIR_ENV_VAR, TEST_RESULTS_DIR_NAME, defaultTestResultsDir } from "../src/paths";