@bigtest/interactor - npm Package Compare versions

Comparing version 0.29.0-ec974429 to 0.29.0

CHANGELOG.md

@@ -8,2 +8,4 @@ # @bigtest/interactor
 - 448c034d: Deprecate matchers' format() for description()
+- 6d69281a: Add `read` function to simplify getting values from element by using filter functions
+- 0664aa51: Throw error if interactor is not given a label
 
@@ -10,0 +12,0 @@ ### Patch Changes

dist/cjs/constructor.js

 "use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createConstructor = exports.instantiateInteractor = exports.instantiateBaseInteractor = exports.unsafeSyncResolveParent = exports.resolveEmpty = exports.resolveNonEmpty = exports.resolveUnique = exports.findElements = void 0;
+exports.createConstructor = exports.instantiateInteractor = exports.instantiateBaseInteractor = exports.unsafeSyncResolveUnique = exports.unsafeSyncResolveParent = exports.resolveEmpty = exports.resolveNonEmpty = exports.resolveUnique = exports.findElements = void 0;
 const globals_1 = require("@bigtest/globals");
@@ -30,2 +30,5 @@ const converge_1 = require("./converge");
 function findMatches(parentElement, interactor) {
+    if (!interactor.name) {
+        throw new Error('One of your interactors was created without a name. Please provide a label for your interactor:\n\tHTML.extend(\'my interactor\') || createInteractor(\'my interactor\')');
+    }
     return findElements(parentElement, interactor).map((e) => new match_2.Match(e, interactor.filter, interactor.locator));
@@ -102,2 +105,3 @@ }
 }
+exports.unsafeSyncResolveUnique = unsafeSyncResolveUnique;
 function instantiateBaseInteractor(options, resolver) {
@@ -104,0 +108,0 @@ let interactor = {

dist/cjs/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.every = exports.some = exports.not = exports.or = exports.and = exports.matching = exports.including = exports.MultiSelect = exports.Select = exports.RadioButton = exports.CheckBox = exports.TextField = exports.Button = exports.Heading = exports.Link = exports.FormField = exports.HTML = exports.isVisible = exports.blur = exports.focus = exports.focused = exports.fillIn = exports.perform = exports.App = exports.Page = exports.createInspector = exports.createInteractor = void 0;
+exports.every = exports.some = exports.not = exports.or = exports.and = exports.matching = exports.including = exports.MultiSelect = exports.Select = exports.RadioButton = exports.CheckBox = exports.TextField = exports.Button = exports.Heading = exports.Link = exports.FormField = exports.HTML = exports.isVisible = exports.blur = exports.focus = exports.focused = exports.fillIn = exports.perform = exports.read = exports.App = exports.Page = exports.createInspector = exports.createInteractor = void 0;
 var create_interactor_1 = require("./create-interactor");
@@ -12,2 +12,4 @@ Object.defineProperty(exports, "createInteractor", { enumerable: true, get: function () { return create_interactor_1.createInteractor; } });
 Object.defineProperty(exports, "App", { enumerable: true, get: function () { return app_1.App; } });
+var read_1 = require("./read");
+Object.defineProperty(exports, "read", { enumerable: true, get: function () { return read_1.read; } });
 var perform_1 = require("./perform");
@@ -14,0 +16,0 @@ Object.defineProperty(exports, "perform", { enumerable: true, get: function () { return perform_1.perform; } });

dist/constructor.d.ts

@@ -7,2 +7,3 @@ import { InteractorOptions, ActionMethods, InteractorConstructor, Interactor, Filters, Actions, FilterParams, InteractorSpecification, BaseInteractor } from './specification';
 export declare function unsafeSyncResolveParent(options: InteractorOptions<any, any, any>): Element;
+export declare function unsafeSyncResolveUnique<E extends Element>(options: InteractorOptions<E, any, any>): E;
 export declare function instantiateBaseInteractor<E extends Element, F extends Filters<E>, A extends Actions<E>>(options: InteractorOptions<E, F, A>, resolver: (options: InteractorOptions<E, F, A>) => E): BaseInteractor<E, FilterParams<E, F>> & ActionMethods<E, A>;
@@ -9,0 +10,0 @@ export declare function instantiateInteractor<E extends Element, F extends Filters<E>, A extends Actions<E>>(options: InteractorOptions<E, F, A>): Interactor<E, FilterParams<E, F>> & ActionMethods<E, A>;

dist/esm/constructor.js

@@ -26,2 +26,5 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
 function findMatches(parentElement, interactor) {
+    if (!interactor.name) {
+        throw new Error('One of your interactors was created without a name. Please provide a label for your interactor:\n\tHTML.extend(\'my interactor\') || createInteractor(\'my interactor\')');
+    }
     return findElements(parentElement, interactor).map((e) => new Match(e, interactor.filter, interactor.locator));
@@ -91,3 +94,3 @@ }
 }
-function unsafeSyncResolveUnique(options) {
+export function unsafeSyncResolveUnique(options) {
     return resolveUnique(unsafeSyncResolveParent(options), options);
@@ -94,0 +97,0 @@ }

dist/esm/index.js

@@ -5,2 +5,3 @@ export { createInteractor } from './create-interactor';
 export { App } from './app';
+export { read } from './read';
 export { perform } from './perform';
@@ -7,0 +8,0 @@ export { fillIn } from './fill-in';

dist/index.d.ts

@@ -7,2 +7,3 @@ export { Interactor, InteractorSpecificationBuilder, InteractorConstructor, InteractorBuilder, InteractorSpecification } from './specification';
 export { App } from './app';
+export { read } from './read';
 export { perform } from './perform';
@@ -9,0 +10,0 @@ export { fillIn } from './fill-in';

dist/specification.d.ts

@@ -158,2 +158,5 @@ import { Filter } from './filter';
 };
+export declare type FilterReturn<F> = {
+    [P in keyof F]?: F[P] extends MaybeMatcher<infer T> ? T : never;
+};
 export declare type FilterParams<E extends Element, F extends Filters<E>> = keyof F extends never ? never : {
@@ -160,0 +163,0 @@ [P in keyof F]?: F[P] extends FilterFn<infer TArg, E> ? MaybeMatcher<TArg> : F[P] extends FilterObject<infer TArg, E> ? MaybeMatcher<TArg> : never;

package.json

 {
   "name": "@bigtest/interactor",
-  "version": "0.29.0-ec974429",
+  "version": "0.29.0",
   "description": "Interactors for working with applications",
@@ -5,0 +5,0 @@ "main": "dist/cjs/index.js",

src/constructor.ts

@@ -41,2 +41,5 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
 function findMatches(parentElement: Element, interactor: InteractorOptions<any, any, any>): Match<Element, any>[] {
+  if (!interactor.name) {
+    throw new Error('One of your interactors was created without a name. Please provide a label for your interactor:\n\tHTML.extend(\'my interactor\') || createInteractor(\'my interactor\')');
+  }
   return findElements(parentElement, interactor).map((e) => new Match(e, interactor.filter, interactor.locator));
@@ -113,3 +116,3 @@ }
 
-function unsafeSyncResolveUnique<E extends Element>(options: InteractorOptions<E, any, any>): E {
+export function unsafeSyncResolveUnique<E extends Element>(options: InteractorOptions<E, any, any>): E {
   return resolveUnique(unsafeSyncResolveParent(options), options) as E;
@@ -116,0 +119,0 @@ }

src/index.ts

@@ -7,2 +7,3 @@ export { Interactor, InteractorSpecificationBuilder, InteractorConstructor, InteractorBuilder, InteractorSpecification } from './specification';
 export { App } from './app';
+export { read } from './read';
 export { perform } from './perform';
@@ -9,0 +10,0 @@ export { fillIn } from './fill-in';

src/specification.ts

@@ -181,2 +181,6 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
 
+export type FilterReturn<F> = {
+  [P in keyof F]?: F[P] extends MaybeMatcher<infer T> ? T : never;
+}
+
 export type FilterParams<E extends Element, F extends Filters<E>> = keyof F extends never ? never : {
@@ -183,0 +187,0 @@ [P in keyof F]?:

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

743368

increased by1.09%

Number of package files

291

increased by2.46%

Lines of code

6017

increased by1.23%

Worsened metrics

Number of high maintenance alerts

1

increased byInfinity%

No dependency changes