fix(testing-helpers): ts types (#2345)

Create spotty-swans-mate.md

chore: lint files

Author: bennypowers

Diff for: .changeset/spotty-swans-mate.md

@@ -0,0 +1,6 @@
+---
+'@open-wc/testing-helpers': patch
+'@open-wc/testing': patch
+---
+
+Fix the typescript typings in testing helpers for projects that depend on `lit` package

Diff for: packages/testing-helpers/src/fixture-no-side-effect.js

@@ -16,7 +16,7 @@ import { isValidRenderArg } from './lib.js';
  * const el = fixtureSync('<my-el><span></span></my-el>');
  *
  * @template {Element} T
- * @param {import('./litFixture').LitHTMLRenderable} template Either a string or lit-html TemplateResult
+ * @param {import('./renderable').LitHTMLRenderable} template Either a string or lit-html TemplateResult
  * @param {FixtureOptions} [options]
  * @returns {T} First child of the rendered DOM
  */
@@ -49,7 +49,7 @@ export function fixtureSync(template, options) {
  * expect(el.fullyRendered).to.be.true;
  *
  * @template {Element} T
- * @param {import('./litFixture').LitHTMLRenderable} template Either a string or lit-html TemplateResult
+ * @param {import('./renderable').LitHTMLRenderable} template Either a string or lit-html TemplateResult
  * @param {FixtureOptions} [options]
  * @returns {Promise<T>} A Promise that will resolve to the first child of the rendered DOM
  */

Diff for: packages/testing-helpers/src/litFixture.js

@@ -4,17 +4,6 @@ import { fixtureWrapper } from './fixtureWrapper.js';
 import { elementUpdated } from './elementUpdated.js';
 import { NODE_TYPES } from './lib.js';
 
-/**
- * @typedef {
-     import('lit').TemplateResult
-   | import('lit').TemplateResult[]
-   | Node | Node[]
-   | string | string[]
-   | number | number[]
-   | boolean | boolean[]
- } LitHTMLRenderable
- */
-
 const isUsefulNode = ({ nodeType, textContent }) => {
   switch (nodeType) {
     case NODE_TYPES.COMMENT_NODE:
@@ -30,7 +19,7 @@ const isUsefulNode = ({ nodeType, textContent }) => {
  * Setups an element synchronously from the provided lit-html template and puts it in the DOM.
  *
  * @template {Element} T - Is an element or a node
- * @param {LitHTMLRenderable} template
+ * @param {import('./renderable').LitHTMLRenderable} template
  * @param {import('./fixture-no-side-effect.js').FixtureOptions} [options]
  * @param {import('./scopedElementsWrapper.js').ScopedElementsTemplateGetter} [getScopedElementsTemplate]
  * @returns {T}
@@ -55,7 +44,7 @@ export function litFixtureSync(template, options = {}, getScopedElementsTemplate
  * Setups an element asynchronously from the provided lit-html template and puts it in the DOM.
  *
  * @template {Element} T - Is an element or a node
- * @param {LitHTMLRenderable} template
+ * @param {import('./renderable').LitHTMLRenderable} template
  * @param {import('./fixture-no-side-effect.js').FixtureOptions} [options]
  * @returns {Promise<T>}
  */

Diff for: packages/testing-helpers/src/renderable.ts

@@ -0,0 +1,12 @@
+import type { TemplateResult } from 'lit';
+
+export type LitHTMLRenderable = (
+    TemplateResult
+  | TemplateResult[]
+  | Node | Node[]
+  | string | string[]
+  | number | number[]
+  | boolean | boolean[]
+);
+
+export {};

Diff for: packages/testing-helpers/src/scopedElementsWrapper.js

@@ -32,7 +32,7 @@ class ScopedElementsTestWrapper extends ScopedElementsMixin(LitElement) {
     /** @type {ScopedElementsMap} */
     this.scopedElements = {};
 
-    /** @type {import('./litFixture').LitHTMLRenderable} */
+    /** @type {import('./renderable').LitHTMLRenderable} */
     // eslint-disable-next-line no-unused-expressions
     this.template;
   }
@@ -69,7 +69,7 @@ const getWrapperUniqueName = (counter = 0) => {
 /**
  * Wraps the template inside a scopedElements component
  *
- * @param {import('./litFixture').LitHTMLRenderable} template
+ * @param {import('./renderable').LitHTMLRenderable} template
  * @param {ScopedElementsMap} scopedElements
  * @return {TemplateResult}
  */