PRO-16178 feat: support steps in actions (for groupping steps)

Author: uid11

LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2021-2025 SIA Joom
+Copyright (c) 2021-2026 SIA Joom
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

src/actions/blur.ts

@@ -1,5 +1,5 @@
 import {LogEventType} from '../constants/internal';
-import {log} from '../utils/log';
+import {step} from '../step';
 
 import type {Locator} from '@playwright/test';
 
@@ -10,8 +10,11 @@ type Options = Parameters<Locator['blur']>[0];
 /**
  * Blur an element.
  */
-export const blur = async (selector: Selector, options: Options = {}): Promise<void> => {
-  log('Blur an element', {...options, selector}, LogEventType.InternalAction);
-
-  await selector.getPlaywrightLocator().blur(options);
-};
+export const blur = (selector: Selector, options: Options = {}): Promise<void> =>
+  step(
+    'Blur an element',
+    async () => {
+      await selector.getPlaywrightLocator().blur(options);
+    },
+    {payload: {...options, selector}, type: LogEventType.InternalAction},
+  );

src/actions/clearCookies.ts

@@ -0,0 +1,23 @@
+import {LogEventType} from '../constants/internal';
+import {step} from '../step';
+import {getPlaywrightPage} from '../useContext';
+
+import type {BrowserContext} from '@playwright/test';
+
+type Options = Parameters<BrowserContext['clearCookies']>[0];
+
+/**
+ * Clears cookies with the specified cookies parameters.
+ * If there are no cookies parameters, clears all the cookies.
+ */
+export const clearCookies = (cookiesParameters: Options = {}): Promise<void> =>
+  step(
+    'Clears cookies with the specified parameters',
+    async () => {
+      const page = getPlaywrightPage();
+      const context = page.context();
+
+      await context.clearCookies(cookiesParameters);
+    },
+    {payload: cookiesParameters, type: LogEventType.InternalAction},
+  );

src/actions/clearInput.ts

@@ -0,0 +1,20 @@
+import {LogEventType} from '../constants/internal';
+import {step} from '../step';
+
+import type {Locator} from '@playwright/test';
+
+import type {Selector} from '../types/internal';
+
+type Options = Parameters<Locator['clear']>[0];
+
+/**
+ * Clears the input field (of any type).
+ */
+export const clearInput = (selector: Selector, options: Options = {}): Promise<void> =>
+  step(
+    'Clear input field',
+    async () => {
+      await selector.getPlaywrightLocator().clear(options);
+    },
+    {payload: {...options, selector}, type: LogEventType.InternalAction},
+  );

src/actions/clearUpload.ts

@@ -1,5 +1,5 @@
 import {LogEventType} from '../constants/internal';
-import {log} from '../utils/log';
+import {step} from '../step';
 
 import type {Locator} from '@playwright/test';
 
@@ -10,8 +10,11 @@ type Options = Parameters<Locator['click']>[0];
 /**
  * Clicks an element.
  */
-export const click = async (selector: Selector, options: Options = {}): Promise<void> => {
-  log(`Click an element ${selector.description}`, options, LogEventType.InternalAction);
-
-  await selector.getPlaywrightLocator().click(options);
-};
+export const click = (selector: Selector, options: Options = {}): Promise<void> =>
+  step(
+    `Click an element ${selector.description}`,
+    async () => {
+      await selector.getPlaywrightLocator().click(options);
+    },
+    {payload: {...options, selector}, type: LogEventType.InternalAction},
+  );

src/actions/click.ts

@@ -1,24 +1,35 @@
 import {LogEventType} from '../constants/internal';
-import {log} from '../utils/log';
+import {step} from '../step';
+
+import {waitForInterfaceStabilization} from './waitFor';
+
+import type {Locator} from '@playwright/test';
 
 import type {Selector, WithStabilizationInterval} from '../types/internal';
 
-type Options = Record<string, unknown> & WithStabilizationInterval;
+type Options = Parameters<Locator['dispatchEvent']>[2] &
+  WithStabilizationInterval &
+  Readonly<{eventInit?: Parameters<Locator['dispatchEvent']>[1]}>;
 
 /**
  * Dispatches an event over a specified DOM element.
  */
 export const dispatchEvent = (
   selector: Selector,
   eventName: string,
-  {stabilizationInterval, ...options}: Options = {},
-): Promise<void> => {
-  log(
-    'Dispatches an event over a specified element',
-    {...options, selector, stabilizationInterval},
-    LogEventType.InternalAction,
-  );
+  {eventInit, stabilizationInterval, ...options}: Options = {},
+): Promise<void> =>
+  step(
+    `Dispatches an event "${eventName}" over a specified element`,
+    async () => {
+      await selector.getPlaywrightLocator().dispatchEvent(eventName, eventInit, options);
 
-  // TODO
-  return Promise.resolve();
-};
+      if (stabilizationInterval !== undefined && stabilizationInterval > 0) {
+        await waitForInterfaceStabilization(stabilizationInterval);
+      }
+    },
+    {
+      payload: {eventInit, ...options, selector, stabilizationInterval},
+      type: LogEventType.InternalAction,
+    },
+  );

src/actions/deleteCookies.ts

@@ -1,5 +1,5 @@
 import {LogEventType} from '../constants/internal';
-import {log} from '../utils/log';
+import {step} from '../step';
 
 import type {Locator} from '@playwright/test';
 
@@ -10,8 +10,11 @@ type Options = Parameters<Locator['dblclick']>[0];
 /**
  * Double-clicks an element.
  */
-export const doubleClick = async (selector: Selector, options: Options = {}): Promise<void> => {
-  log(`Double-click an element ${selector.description}`, options, LogEventType.InternalAction);
-
-  await selector.getPlaywrightLocator().dblclick(options);
-};
+export const doubleClick = (selector: Selector, options: Options = {}): Promise<void> =>
+  step(
+    `Double-click an element ${selector.description}`,
+    async () => {
+      await selector.getPlaywrightLocator().dblclick(options);
+    },
+    {payload: {...options, selector}, type: LogEventType.InternalAction},
+  );