@lynx-js/testing-environment 0.1.5 → 0.1.6

package/CHANGELOG.md

@@ -0,0 +1,66 @@
+# @lynx-js/testing-environment
+
+## 0.1.6
+
+### Patch Changes
+
+- Fix that `lynxTestingEnv.jsdom` cannot be initialized correctly when `global.jsdom` is not defined. ([#1422](https://github.com/lynx-family/lynx-stack/pull/1422))
+
+## 0.1.5
+
+### Patch Changes
+
+- Fix `GlobalEventEmitter` type definition, the `emit(eventName: string, data: unknown)` function should recevie an array typed `data` and pass as param list of listeners. ([#1479](https://github.com/lynx-family/lynx-stack/pull/1479))
+
+## 0.1.4
+
+### Patch Changes
+
+- Fix the thread switching bug in `lynx.getCoreContext` and `lynx.getJSContext`. ([#1244](https://github.com/lynx-family/lynx-stack/pull/1244))
+
+## 0.1.3
+
+### Patch Changes
+
+- Support alog of component rendering on production for better error reporting. Enable it by using `REACT_ALOG=true rspeedy dev/build` or defining `__ALOG__` to `true` in `lynx.config.js`: ([#1164](https://github.com/lynx-family/lynx-stack/pull/1164))
+
+  ```js
+  export default defineConfig({
+    // ...
+    source: {
+      define: {
+        __ALOG__: true,
+      },
+    },
+  });
+  ```
+
+- Supports `console.alog` and use different `console` object in main thread and background thread. ([#1164](https://github.com/lynx-family/lynx-stack/pull/1164))
+
+## 0.1.2
+
+### Patch Changes
+
+- Fix the infinite loop in the `__RemoveElement` element PAPI. ([#1263](https://github.com/lynx-family/lynx-stack/pull/1263))
+
+## 0.1.1
+
+### Patch Changes
+
+- Fix `getJSContext` or `getCoreContext` is not a function. ([#1122](https://github.com/lynx-family/lynx-stack/pull/1122))
+
+## 0.1.0
+
+### Minor Changes
+
+- Switch to ESM package format by setting `"type": "module"`. ([#703](https://github.com/lynx-family/lynx-stack/pull/703))
+
+### Patch Changes
+
+- rename @lynx-js/test-environment to @lynx-js/testing-environment ([#704](https://github.com/lynx-family/lynx-stack/pull/704))
+
+## 0.0.1
+
+### Patch Changes
+
+- Add testing library for ReactLynx ([#74](https://github.com/lynx-family/lynx-stack/pull/74))

package/README.md

@@ -8,8 +8,9 @@ The Element PAPI implementation is based on jsdom, for example `__CreateElement`
 
 ```js
 import { LynxTestingEnv } from '@lynx-js/testing-environment';
+import { JSDOM } from 'jsdom';
 
-const lynxTestingEnv = new LynxTestingEnv();
+const lynxTestingEnv = new LynxTestingEnv(new JSDOM());
 ```
 
 To use `@lynx-js/testing-environment`, you will primarily use the `LynxTestingEnv` constructor, which is a named export of the package. You will get back a `LynxTestingEnv` instance, which has a number of methods of useful properties, notably `switchToMainThread` and `switchToBackgroundThread`, which allow you to switch between the main thread and background thread.

package/dist/env/vitest/index.cjs

@@ -34,8 +34,7 @@ const env = {
     async setup (global) {
         const fakeGlobal = {};
         await environments_namespaceObject.builtinEnvironments.jsdom.setup(fakeGlobal, {});
-        global.jsdom = fakeGlobal.jsdom;
-        const lynxTestingEnv = new testing_environment_namespaceObject.LynxTestingEnv();
+        const lynxTestingEnv = new testing_environment_namespaceObject.LynxTestingEnv(fakeGlobal.jsdom);
         global.lynxTestingEnv = lynxTestingEnv;
         return {
             teardown (global) {

package/dist/env/vitest/index.js

@@ -6,8 +6,7 @@ const env = {
     async setup (global) {
         const fakeGlobal = {};
         await builtinEnvironments.jsdom.setup(fakeGlobal, {});
-        global.jsdom = fakeGlobal.jsdom;
-        const lynxTestingEnv = new LynxTestingEnv();
+        const lynxTestingEnv = new LynxTestingEnv(fakeGlobal.jsdom);
         global.lynxTestingEnv = lynxTestingEnv;
         return {
             teardown (global) {

package/dist/index.cjs

@@ -310,11 +310,13 @@ class LynxTestingEnv {
         this.switchToBackgroundThread();
         null == (_globalThis_onResetLynxTestingEnv = (_globalThis = globalThis).onResetLynxTestingEnv) || _globalThis_onResetLynxTestingEnv.call(_globalThis);
     }
-    constructor(){
+    constructor(jsdom){
         _define_property(this, "originals", new Map());
         _define_property(this, "backgroundThread", void 0);
         _define_property(this, "mainThread", void 0);
-        _define_property(this, "jsdom", global.jsdom);
+        _define_property(this, "jsdom", void 0);
+        this.jsdom = jsdom ?? global.jsdom;
+        if (!this.jsdom) throw new Error("LynxTestingEnv requires a JSDOM instance. Pass one to the constructor, or ensure your test runner sets global.jsdom (e.g., via a setup file).");
         this.backgroundThread = (0, GlobalThis_cjs_namespaceObject.createGlobalThis)();
         this.mainThread = (0, GlobalThis_cjs_namespaceObject.createGlobalThis)();
         const globalPolyfills = {

package/dist/index.d.ts

@@ -56,7 +56,7 @@ declare global {
  * ```ts
  * import { LynxTestingEnv } from '@lynx-js/testing-environment';
  *
- * const lynxTestingEnv = new LynxTestingEnv();
+ * const lynxTestingEnv = new LynxTestingEnv(new JSDOM());
  *
  * lynxTestingEnv.switchToMainThread();
  * // use the main thread Element PAPI
@@ -78,7 +78,7 @@ export declare class LynxTestingEnv {
      * ```ts
      * import { LynxTestingEnv } from '@lynx-js/testing-environment';
      *
-     * const lynxTestingEnv = new LynxTestingEnv();
+     * const lynxTestingEnv = new LynxTestingEnv(new JSDOM());
      *
      * lynxTestingEnv.switchToBackgroundThread();
      * // use the background thread global object
@@ -94,7 +94,7 @@ export declare class LynxTestingEnv {
      * ```ts
      * import { LynxTestingEnv } from '@lynx-js/testing-environment';
      *
-     * const lynxTestingEnv = new LynxTestingEnv();
+     * const lynxTestingEnv = new LynxTestingEnv(new JSDOM());
      *
      * lynxTestingEnv.switchToMainThread();
      * // use the main thread global object
@@ -105,7 +105,7 @@ export declare class LynxTestingEnv {
      */
     mainThread: LynxGlobalThis & ElementTreeGlobals;
     jsdom: JSDOM;
-    constructor();
+    constructor(jsdom?: JSDOM);
     injectGlobals(): void;
     switchToBackgroundThread(): void;
     switchToMainThread(): void;

package/dist/index.js

@@ -271,11 +271,13 @@ class LynxTestingEnv {
         this.switchToBackgroundThread();
         null == (_globalThis_onResetLynxTestingEnv = (_globalThis = globalThis).onResetLynxTestingEnv) || _globalThis_onResetLynxTestingEnv.call(_globalThis);
     }
-    constructor(){
+    constructor(jsdom){
         _define_property(this, "originals", new Map());
         _define_property(this, "backgroundThread", void 0);
         _define_property(this, "mainThread", void 0);
-        _define_property(this, "jsdom", global.jsdom);
+        _define_property(this, "jsdom", void 0);
+        this.jsdom = jsdom ?? global.jsdom;
+        if (!this.jsdom) throw new Error("LynxTestingEnv requires a JSDOM instance. Pass one to the constructor, or ensure your test runner sets global.jsdom (e.g., via a setup file).");
         this.backgroundThread = createGlobalThis();
         this.mainThread = createGlobalThis();
         const globalPolyfills = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/testing-environment",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "A subset of a Lynx environment to be useful for testing",
   "keywords": [
     "Lynx",
@@ -43,12 +43,13 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "devDependencies": {
-    "@testing-library/jest-dom": "^6.6.4",
+    "@testing-library/jest-dom": "^6.7.0",
     "@types/jsdom": "^21.1.7",
-    "rsbuild-plugin-publint": "0.3.2"
+    "rsbuild-plugin-publint": "0.3.3"
   },
   "scripts": {
     "api-extractor": "api-extractor run --verbose",