@rvoh/psychic-spec-helpers 0.4.0 → 0.4.2

package/dist/esm/src/feature/helpers/launchDevServer.js

@@ -16,6 +16,7 @@ export default async function launchDevServer(key, { port = 3000, cmd = 'yarn cl
             VITE_PSYCHIC_ENV: 'test',
         },
     });
+    devServerProcesses[key] = proc;
     await waitForPort(key, port, timeout);
     proc.on('error', err => {
         throw err;

package/dist/esm/src/feature/helpers/matcher-globals/check.js

@@ -0,0 +1,3 @@
+export default async function check(expectedText, opts) {
+    await expect(page).toCheck(expectedText, opts);
+}

package/dist/esm/src/feature/helpers/matcher-globals/click.js

@@ -0,0 +1,3 @@
+export default async function click(selector, opts) {
+    await expect(page).toClick(selector, opts);
+}

package/dist/esm/src/feature/helpers/matcher-globals/clickButton.js

@@ -0,0 +1,3 @@
+export default async function clickButton(expectedText, opts) {
+    await expect(page).toClickButton(expectedText, opts);
+}

package/dist/esm/src/feature/helpers/matcher-globals/clickLink.js

@@ -0,0 +1,3 @@
+export default async function clickLink(expectedText, opts) {
+    await expect(page).toClickLink(expectedText, opts);
+}

package/dist/esm/src/feature/helpers/matcher-globals/clickSelector.js

@@ -0,0 +1,3 @@
+export default async function clickSelector(selector, opts) {
+    await expect(page).toClickSelector(selector, opts);
+}

package/dist/esm/src/feature/helpers/matcher-globals/fillIn.js

@@ -0,0 +1,3 @@
+export default async function fillIn(cssSelector, text, opts) {
+    await expect(page).toFill(cssSelector, text, opts);
+}

package/dist/esm/src/feature/helpers/matcher-globals/uncheck.js

@@ -0,0 +1,3 @@
+export default async function uncheck(expectedText, opts) {
+    await expect(page).toUncheck(expectedText, opts);
+}

package/dist/esm/src/feature/helpers/providePuppeteerViteMatchers.js

@@ -1,20 +1,28 @@
 import evaluateWithRetryAndTimeout from '../internal/evaluateWithRetryAndTimeout.js';
-import toHaveSelector from '../matchers/toHaveSelector.js';
-import toMatchTextContent from '../matchers/toMatchTextContent.js';
-import toNotHaveSelector from '../matchers/toNotHaveSelector.js';
-import toNotMatchTextContent from '../matchers/toNotMatchTextContent.js';
 import toCheck from '../matchers/toCheck.js';
-import toUncheck from '../matchers/toUncheck.js';
 import toClick from '../matchers/toClick.js';
-import toClickLink from '../matchers/toClickLink.js';
 import toClickButton from '../matchers/toClickButton.js';
+import toClickLink from '../matchers/toClickLink.js';
 import toClickSelector from '../matchers/toClickSelector.js';
-import toHavePath from '../matchers/toHavePath.js';
-import toHaveUrl from '../matchers/toHaveUrl.js';
-import toHaveLink from '../matchers/toHaveLink.js';
+import toFill from '../matchers/toFill.js';
 import toHaveChecked from '../matchers/toHaveChecked.js';
+import toHaveLink from '../matchers/toHaveLink.js';
+import toHavePath from '../matchers/toHavePath.js';
+import toHaveSelector from '../matchers/toHaveSelector.js';
 import toHaveUnchecked from '../matchers/toHaveUnchecked.js';
-import toFill from '../matchers/toFill.js';
+import toHaveUrl from '../matchers/toHaveUrl.js';
+import toMatchTextContent from '../matchers/toMatchTextContent.js';
+import toNotHaveSelector from '../matchers/toNotHaveSelector.js';
+import toNotMatchTextContent from '../matchers/toNotMatchTextContent.js';
+import toUncheck from '../matchers/toUncheck.js';
+import check from './matcher-globals/check.js';
+import click from './matcher-globals/click.js';
+import clickButton from './matcher-globals/clickButton.js';
+import clickLink from './matcher-globals/clickLink.js';
+import clickSelector from './matcher-globals/clickSelector.js';
+import fillIn from './matcher-globals/fillIn.js';
+import uncheck from './matcher-globals/uncheck.js';
+import visit from './visit.js';
 export default function providePuppeteerViteMatchers() {
     ;
     global.expect.extend({
@@ -70,4 +78,13 @@ export default function providePuppeteerViteMatchers() {
             return await evaluateWithRetryAndTimeout(argumentPassedToExpect, evaluationFn, opts);
         },
     });
+    global.context ||= describe;
+    global.check = check;
+    global.click = click;
+    global.clickButton = clickButton;
+    global.clickLink = clickLink;
+    global.clickSelector = clickSelector;
+    global.fillIn = fillIn;
+    global.uncheck = uncheck;
+    global.visit = visit;
 }

package/dist/types/src/feature/helpers/matcher-globals/check.d.ts

@@ -0,0 +1,2 @@
+import { WaitForSelectorOptions } from 'puppeteer';
+export default function check(expectedText: string, opts?: WaitForSelectorOptions): Promise<void>;

package/dist/types/src/feature/helpers/matcher-globals/click.d.ts

@@ -0,0 +1,2 @@
+import { WaitForSelectorOptions } from 'puppeteer';
+export default function click(selector: string, opts?: WaitForSelectorOptions): Promise<void>;

package/dist/types/src/feature/helpers/matcher-globals/clickButton.d.ts

@@ -0,0 +1,2 @@
+import { WaitForSelectorOptions } from 'puppeteer';
+export default function clickButton(expectedText: string, opts?: WaitForSelectorOptions): Promise<void>;

package/dist/types/src/feature/helpers/matcher-globals/clickLink.d.ts

@@ -0,0 +1,2 @@
+import { WaitForSelectorOptions } from 'puppeteer';
+export default function clickLink(expectedText: string, opts?: WaitForSelectorOptions): Promise<void>;

package/dist/types/src/feature/helpers/matcher-globals/clickSelector.d.ts

@@ -0,0 +1,2 @@
+import { WaitForSelectorOptions } from 'puppeteer';
+export default function clickSelector(selector: string, opts?: WaitForSelectorOptions): Promise<void>;

package/dist/types/src/feature/helpers/matcher-globals/fillIn.d.ts

@@ -0,0 +1,2 @@
+import { ToFillMatcherOpts } from '../../matchers/toFill.js';
+export default function fillIn(cssSelector: string, text: string, opts?: ToFillMatcherOpts): Promise<void>;

package/dist/types/src/feature/helpers/matcher-globals/uncheck.d.ts

@@ -0,0 +1,2 @@
+import { WaitForSelectorOptions } from 'puppeteer';
+export default function uncheck(expectedText: string, opts?: WaitForSelectorOptions): Promise<void>;

package/dist/types/src/index.d.ts

@@ -12,8 +12,16 @@ export { default as launchPage } from './feature/helpers/launchPage.js';
 export { default as launchDevServer, stopDevServers, stopDevServer, } from './feature/helpers/launchDevServer.js';
 export { default as visit } from './feature/helpers/visit.js';
 declare global {
-    function context(description: string, callback: () => void): void;
+    const context: (typeof import('vitest'))['describe'];
     const page: InstanceType<typeof Page>;
+    const visit: (typeof import('./feature/helpers/visit.js'))['default'];
+    const check: (typeof import('./feature/helpers/matcher-globals/check.js'))['default'];
+    const click: (typeof import('./feature/helpers/matcher-globals/click.js'))['default'];
+    const clickButton: (typeof import('./feature/helpers/matcher-globals/clickButton.js'))['default'];
+    const clickLink: (typeof import('./feature/helpers/matcher-globals/clickLink.js'))['default'];
+    const clickSelector: (typeof import('./feature/helpers/matcher-globals/clickSelector.js'))['default'];
+    const fillIn: (typeof import('./feature/helpers/matcher-globals/fillIn.js'))['default'];
+    const uncheck: (typeof import('./feature/helpers/matcher-globals/uncheck.js'))['default'];
 }
 declare module 'vitest' {
     interface ExpectStatic extends PuppeteerAssertions {

package/package.json

@@ -1,8 +1,13 @@
 {
   "type": "module",
   "name": "@rvoh/psychic-spec-helpers",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "psychic framework spec helpers",
+  "author": "RVO Health",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rvohealth/psychic-spec-helpers.git"
+  },
   "main": "./dist/cjs/src/index.js",
   "module": "./dist/esm/src/index.js",
   "types": "./dist/types/src/index.d.ts",
@@ -39,9 +44,9 @@
     "supertest": "^7.0.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4",
-    "vitest": "^3.0.8"
+    "vitest": "^3.1.1"
   },
   "dependencies": {
     "cookiejar": "^2.1.4"
   }
-}
+}

package/src/feature/helpers/launchDevServer.ts

@@ -26,6 +26,8 @@ export default async function launchDevServer(
     },
   })
 
+  devServerProcesses[key] = proc
+
   await waitForPort(key, port, timeout)
 
   proc.on('error', err => {

package/src/feature/helpers/matcher-globals/check.ts

@@ -0,0 +1,5 @@
+import { WaitForSelectorOptions } from 'puppeteer'
+
+export default async function check(expectedText: string, opts?: WaitForSelectorOptions) {
+  await expect(page).toCheck(expectedText, opts)
+}

package/src/feature/helpers/matcher-globals/click.ts

@@ -0,0 +1,5 @@
+import { WaitForSelectorOptions } from 'puppeteer'
+
+export default async function click(selector: string, opts?: WaitForSelectorOptions) {
+  await expect(page).toClick(selector, opts)
+}

package/src/feature/helpers/matcher-globals/clickButton.ts

@@ -0,0 +1,5 @@
+import { WaitForSelectorOptions } from 'puppeteer'
+
+export default async function clickButton(expectedText: string, opts?: WaitForSelectorOptions) {
+  await expect(page).toClickButton(expectedText, opts)
+}

package/src/feature/helpers/matcher-globals/clickLink.ts

@@ -0,0 +1,5 @@
+import { WaitForSelectorOptions } from 'puppeteer'
+
+export default async function clickLink(expectedText: string, opts?: WaitForSelectorOptions) {
+  await expect(page).toClickLink(expectedText, opts)
+}

package/src/feature/helpers/matcher-globals/clickSelector.ts

@@ -0,0 +1,5 @@
+import { WaitForSelectorOptions } from 'puppeteer'
+
+export default async function clickSelector(selector: string, opts?: WaitForSelectorOptions) {
+  await expect(page).toClickSelector(selector, opts)
+}

package/src/feature/helpers/matcher-globals/fillIn.ts

@@ -0,0 +1,5 @@
+import { ToFillMatcherOpts } from '../../matchers/toFill.js'
+
+export default async function fillIn(cssSelector: string, text: string, opts?: ToFillMatcherOpts) {
+  await expect(page).toFill(cssSelector, text, opts)
+}

package/src/feature/helpers/matcher-globals/uncheck.ts

@@ -0,0 +1,5 @@
+import { WaitForSelectorOptions } from 'puppeteer'
+
+export default async function uncheck(expectedText: string, opts?: WaitForSelectorOptions) {
+  await expect(page).toUncheck(expectedText, opts)
+}

package/src/feature/helpers/providePuppeteerViteMatchers.ts

@@ -3,22 +3,30 @@ import evaluateWithRetryAndTimeout, {
   ExpectToEvaluateOpts,
   ExpectToEvaluateReturnType,
 } from '../internal/evaluateWithRetryAndTimeout.js'
-import toHaveSelector from '../matchers/toHaveSelector.js'
-import toMatchTextContent from '../matchers/toMatchTextContent.js'
-import toNotHaveSelector from '../matchers/toNotHaveSelector.js'
-import toNotMatchTextContent from '../matchers/toNotMatchTextContent.js'
 import toCheck from '../matchers/toCheck.js'
-import toUncheck from '../matchers/toUncheck.js'
 import toClick from '../matchers/toClick.js'
-import toClickLink from '../matchers/toClickLink.js'
 import toClickButton from '../matchers/toClickButton.js'
+import toClickLink from '../matchers/toClickLink.js'
 import toClickSelector from '../matchers/toClickSelector.js'
-import toHavePath from '../matchers/toHavePath.js'
-import toHaveUrl from '../matchers/toHaveUrl.js'
-import toHaveLink from '../matchers/toHaveLink.js'
+import toFill, { ToFillMatcherOpts } from '../matchers/toFill.js'
 import toHaveChecked from '../matchers/toHaveChecked.js'
+import toHaveLink from '../matchers/toHaveLink.js'
+import toHavePath from '../matchers/toHavePath.js'
+import toHaveSelector from '../matchers/toHaveSelector.js'
 import toHaveUnchecked from '../matchers/toHaveUnchecked.js'
-import toFill, { ToFillMatcherOpts } from '../matchers/toFill.js'
+import toHaveUrl from '../matchers/toHaveUrl.js'
+import toMatchTextContent from '../matchers/toMatchTextContent.js'
+import toNotHaveSelector from '../matchers/toNotHaveSelector.js'
+import toNotMatchTextContent from '../matchers/toNotMatchTextContent.js'
+import toUncheck from '../matchers/toUncheck.js'
+import check from './matcher-globals/check.js'
+import click from './matcher-globals/click.js'
+import clickButton from './matcher-globals/clickButton.js'
+import clickLink from './matcher-globals/clickLink.js'
+import clickSelector from './matcher-globals/clickSelector.js'
+import fillIn from './matcher-globals/fillIn.js'
+import uncheck from './matcher-globals/uncheck.js'
+import visit from './visit.js'
 
 export default function providePuppeteerViteMatchers() {
   ;((global as any).expect as any).extend({
@@ -98,6 +106,21 @@ export default function providePuppeteerViteMatchers() {
       return await evaluateWithRetryAndTimeout(argumentPassedToExpect, evaluationFn, opts)
     },
   })
+
+  // set globals
+
+  // define global context variable, setting it equal to describe
+  ;(global as any).context ||= describe
+
+  // define global helper functions
+  ;(global as any).check = check
+  ;(global as any).click = click
+  ;(global as any).clickButton = clickButton
+  ;(global as any).clickLink = clickLink
+  ;(global as any).clickSelector = clickSelector
+  ;(global as any).fillIn = fillIn
+  ;(global as any).uncheck = uncheck
+  ;(global as any).visit = visit
 }
 
 export interface CustomMatcherResult {

package/src/index.ts

@@ -21,8 +21,16 @@ export {
 export { default as visit } from './feature/helpers/visit.js'
 
 declare global {
-  function context(description: string, callback: () => void): void
+  const context: (typeof import('vitest'))['describe']
   const page: InstanceType<typeof Page>
+  const visit: (typeof import('./feature/helpers/visit.js'))['default']
+  const check: (typeof import('./feature/helpers/matcher-globals/check.js'))['default']
+  const click: (typeof import('./feature/helpers/matcher-globals/click.js'))['default']
+  const clickButton: (typeof import('./feature/helpers/matcher-globals/clickButton.js'))['default']
+  const clickLink: (typeof import('./feature/helpers/matcher-globals/clickLink.js'))['default']
+  const clickSelector: (typeof import('./feature/helpers/matcher-globals/clickSelector.js'))['default']
+  const fillIn: (typeof import('./feature/helpers/matcher-globals/fillIn.js'))['default']
+  const uncheck: (typeof import('./feature/helpers/matcher-globals/uncheck.js'))['default']
 }
 
 declare module 'vitest' {