@interactors/core 1.0.0 → 1.1.0-alpha.1

package/script/src/metadata.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MATCHER_CONSTRUCTOR_METADATA = exports.INTERACTOR_CONSTRUCTOR_METADATA = exports.CONSTRUCTOR_METADATA_VERSION = void 0;
+exports.getInteractorConstructorMetadata = getInteractorConstructorMetadata;
+exports.isInteractorConstructor = isInteractorConstructor;
+exports.getMatcherConstructorMetadata = getMatcherConstructorMetadata;
+exports.isMatcherConstructor = isMatcherConstructor;
+exports.defineInteractorConstructorMetadata = defineInteractorConstructorMetadata;
+exports.defineMatcherConstructorMetadata = defineMatcherConstructorMetadata;
+/**
+ * Version of the metadata attached to interactor and matcher constructors.
+ *
+ * Consumers should use the helpers in this module instead of reading the
+ * symbol properties directly.
+ */
+exports.CONSTRUCTOR_METADATA_VERSION = 1;
+/** @internal */
+exports.INTERACTOR_CONSTRUCTOR_METADATA = Symbol.for("@interactors/core/interactor-constructor-metadata");
+/** @internal */
+exports.MATCHER_CONSTRUCTOR_METADATA = Symbol.for("@interactors/core/matcher-constructor-metadata");
+/**
+ * Return stable, serializable metadata for an interactor constructor.
+ */
+function getInteractorConstructorMetadata(value) {
+    if (typeof value !== "function") {
+        return undefined;
+    }
+    let metadata = Reflect.get(value, exports.INTERACTOR_CONSTRUCTOR_METADATA);
+    return isInteractorConstructorMetadata(metadata) ? metadata : undefined;
+}
+/**
+ * Determine whether a value was created by {@link createInteractor}.
+ *
+ * The brand uses the global symbol registry so this works when the producer
+ * and consumer load different copies of `@interactors/core`.
+ */
+function isInteractorConstructor(value) {
+    return getInteractorConstructorMetadata(value) !== undefined;
+}
+/**
+ * Return stable, serializable metadata for a matcher constructor.
+ */
+function getMatcherConstructorMetadata(value) {
+    if (typeof value !== "function") {
+        return undefined;
+    }
+    let metadata = Reflect.get(value, exports.MATCHER_CONSTRUCTOR_METADATA);
+    return isMatcherConstructorMetadata(metadata) ? metadata : undefined;
+}
+/** Determine whether a value was created by {@link createMatcher}. */
+function isMatcherConstructor(value) {
+    return getMatcherConstructorMetadata(value) !== undefined;
+}
+/** @internal */
+function defineInteractorConstructorMetadata(constructor, metadata) {
+    defineMetadata(constructor, exports.INTERACTOR_CONSTRUCTOR_METADATA, {
+        kind: "interactor",
+        version: exports.CONSTRUCTOR_METADATA_VERSION,
+        name: metadata.name,
+        actions: Object.freeze([...metadata.actions].sort()),
+        filters: Object.freeze([...metadata.filters].sort()),
+    });
+}
+/** @internal */
+function defineMatcherConstructorMetadata(constructor, metadata) {
+    defineMetadata(constructor, exports.MATCHER_CONSTRUCTOR_METADATA, {
+        kind: "matcher",
+        version: exports.CONSTRUCTOR_METADATA_VERSION,
+        name: metadata.name,
+    });
+}
+function defineMetadata(constructor, key, metadata) {
+    Object.defineProperty(constructor, key, {
+        configurable: false,
+        enumerable: false,
+        writable: false,
+        value: Object.freeze(metadata),
+    });
+}
+function isInteractorConstructorMetadata(value) {
+    if (!isRecord(value)) {
+        return false;
+    }
+    return value.kind === "interactor" &&
+        value.version === exports.CONSTRUCTOR_METADATA_VERSION &&
+        typeof value.name === "string" &&
+        isStringArray(value.actions) &&
+        isStringArray(value.filters);
+}
+function isMatcherConstructorMetadata(value) {
+    if (!isRecord(value)) {
+        return false;
+    }
+    return value.kind === "matcher" &&
+        value.version === exports.CONSTRUCTOR_METADATA_VERSION &&
+        typeof value.name === "string";
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null;
+}
+function isStringArray(value) {
+    return Array.isArray(value) &&
+        value.every((item) => typeof item === "string");
+}
+//# sourceMappingURL=metadata.js.map

package/script/src/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/src/metadata.ts"],"names":[],"mappings":";;;AA+CA,4EAUC;AAQD,0DAIC;AAKD,sEAUC;AAGD,oDAIC;AAGD,kFAWC;AAGD,4EASC;AAlHD;;;;;GAKG;AACU,QAAA,4BAA4B,GAAG,CAAU,CAAC;AAEvD,gBAAgB;AACH,QAAA,+BAA+B,GAAG,MAAM,CAAC,GAAG,CACvD,mDAAmD,CACpD,CAAC;AAEF,gBAAgB;AACH,QAAA,4BAA4B,GAAG,MAAM,CAAC,GAAG,CACpD,gDAAgD,CACjD,CAAC;AAyBF;;GAEG;AACH,SAAgB,gCAAgC,CAC9C,KAAc;IAEd,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,uCAA+B,CAAC,CAAC;IAEnE,OAAO,+BAA+B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1E,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,KAAc;IAEd,OAAO,gCAAgC,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC;AAC/D,CAAC;AAED;;GAEG;AACH,SAAgB,6BAA6B,CAC3C,KAAc;IAEd,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,oCAA4B,CAAC,CAAC;IAEhE,OAAO,4BAA4B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AACvE,CAAC;AAED,sEAAsE;AACtE,SAAgB,oBAAoB,CAClC,KAAc;IAEd,OAAO,6BAA6B,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC;AAC5D,CAAC;AAED,gBAAgB;AAChB,SAAgB,mCAAmC,CACjD,WAAqB,EACrB,QAAiE;IAEjE,cAAc,CAAC,WAAW,EAAE,uCAA+B,EAAE;QAC3D,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE,oCAA4B;QACrC,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;QACpD,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;KACrD,CAAC,CAAC;AACL,CAAC;AAED,gBAAgB;AAChB,SAAgB,gCAAgC,CAC9C,WAAqB,EACrB,QAA8D;IAE9D,cAAc,CAAC,WAAW,EAAE,oCAA4B,EAAE;QACxD,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,oCAA4B;QACrC,IAAI,EAAE,QAAQ,CAAC,IAAI;KACpB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,cAAc,CACrB,WAAqB,EACrB,GAAW,EACX,QAAoE;IAEpE,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,GAAG,EAAE;QACtC,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;KAC/B,CAAC,CAAC;AACL,CAAC;AAED,SAAS,+BAA+B,CACtC,KAAc;IAEd,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,KAAK,YAAY;QAChC,KAAK,CAAC,OAAO,KAAK,oCAA4B;QAC9C,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5B,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,4BAA4B,CACnC,KAAc;IAEd,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS;QAC7B,KAAK,CAAC,OAAO,KAAK,oCAA4B;QAC9C,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACzB,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AACpD,CAAC"}

package/script/src/resolvers.d.ts

@@ -0,0 +1,9 @@
+import type { InteractorOptions } from './specification.js';
+export declare function findElements<E extends Element>(parentElement: Element, interactor: InteractorOptions<any, any, any>): E[];
+export declare function hasMatchMatching(parentElement: Element, interactor: InteractorOptions<any, any, any>): boolean;
+export declare function resolveUnique(parentElement: Element, interactor: InteractorOptions<any, any, any>): Element;
+export declare function resolveFirst(parentElement: Element, interactor: InteractorOptions<any, any, any>): Element;
+export declare function resolveEmpty(parentElement: Element, interactor: InteractorOptions<any, any, any>): void;
+export declare function unsafeSyncResolveParent(options: InteractorOptions<any, any, any>): Element;
+export declare function unsafeSyncResolveUnique<E extends Element>(options: InteractorOptions<E, any, any>): E;
+//# sourceMappingURL=resolvers.d.ts.map

package/script/src/resolvers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvers.d.ts","sourceRoot":"","sources":["../../src/src/resolvers.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAI5D,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAYzH;AA0BD,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,OAAO,CAE9G;AAcD,wBAAgB,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,OAAO,CAS3G;AAID,wBAAgB,YAAY,CAAC,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,OAAO,CAE1G;AAID,wBAAgB,YAAY,CAAC,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAOvG;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,OAAO,CAE1F;AAED,wBAAgB,uBAAuB,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAErG"}

package/{dist/cjs → script/src}/resolvers.js

@@ -1,11 +1,17 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unsafeSyncResolveUnique = exports.unsafeSyncResolveParent = exports.resolveEmpty = exports.resolveFirst = exports.resolveUnique = exports.hasMatchMatching = exports.findElements = void 0;
+exports.findElements = findElements;
+exports.hasMatchMatching = hasMatchMatching;
+exports.resolveUnique = resolveUnique;
+exports.resolveFirst = resolveFirst;
+exports.resolveEmpty = resolveEmpty;
+exports.unsafeSyncResolveParent = unsafeSyncResolveParent;
+exports.unsafeSyncResolveUnique = unsafeSyncResolveUnique;
 const globals_1 = require("@interactors/globals");
-const match_1 = require("./match");
-const errors_1 = require("./errors");
-const format_1 = require("./format");
+const match_js_1 = require("./match.js");
+const errors_js_1 = require("./errors.js");
+const format_js_1 = require("./format.js");
 const defaultSelector = 'div';
 function findElements(parentElement, interactor) {
     if (!interactor.name) {
@@ -22,22 +28,21 @@ function findElements(parentElement, interactor) {
         return Array.from(parentElement.querySelectorAll(interactor.specification.selector || defaultSelector));
     }
 }
-exports.findElements = findElements;
 function findMatches(parentElement, interactor) {
-    return findElements(parentElement, interactor).map((e) => new match_1.Match(e, interactor.filter, interactor.locator));
+    return findElements(parentElement, interactor).map((e) => new match_js_1.Match(e, interactor.filter, interactor.locator));
 }
 function throwNoSuchElementError(matches, interactor) {
     if (matches.length === 0) {
-        throw new errors_1.NoSuchElementError(`did not find ${(0, format_1.formatDescription)(interactor)}`);
+        throw new errors_js_1.NoSuchElementError(`did not find ${(0, format_js_1.formatDescription)(interactor)}`);
     }
     else {
-        throw new errors_1.NoSuchElementError(`did not find ${(0, format_1.formatDescription)(interactor)}, did you mean one of:\n\n${(0, format_1.formatMatchesTable)(interactor, matches)}`);
+        throw new errors_js_1.NoSuchElementError(`did not find ${(0, format_js_1.formatDescription)(interactor)}, did you mean one of:\n\n${(0, format_js_1.formatMatchesTable)(interactor, matches)}`);
     }
 }
 function findFirstMatch(parentElement, interactor) {
     let matches = [];
     for (let element of findElements(parentElement, interactor)) {
-        let match = new match_1.Match(element, interactor.filter, interactor.locator);
+        let match = new match_js_1.Match(element, interactor.filter, interactor.locator);
         matches.push(match);
         if (match.matches) {
             return match;
@@ -46,9 +51,8 @@ function findFirstMatch(parentElement, interactor) {
     throwNoSuchElementError(matches, interactor);
 }
 function hasMatchMatching(parentElement, interactor) {
-    return findElements(parentElement, interactor).some(element => new match_1.Match(element, interactor.filter, interactor.locator).matches);
+    return findElements(parentElement, interactor).some(element => new match_js_1.Match(element, interactor.filter, interactor.locator).matches);
 }
-exports.hasMatchMatching = hasMatchMatching;
 function findMatchesNonEmpty(parentElement, interactor) {
     let matches = findMatches(parentElement, interactor);
     let matching = matches.filter((m) => m.matches);
@@ -67,32 +71,27 @@ function resolveUnique(parentElement, interactor) {
     }
     else {
         let alternatives = matching.map((m) => '- ' + m.elementDescription());
-        throw new errors_1.AmbiguousElementError(`${(0, format_1.formatDescription)(interactor)} matches multiple elements:\n\n${alternatives.join('\n')}`);
+        throw new errors_js_1.AmbiguousElementError(`${(0, format_js_1.formatDescription)(interactor)} matches multiple elements:\n\n${alternatives.join('\n')}`);
     }
 }
-exports.resolveUnique = resolveUnique;
 // Given a parent element, and an interactor, find the first matching element and
 // return it. If no elements match, raise an error.
 function resolveFirst(parentElement, interactor) {
     return findFirstMatch(parentElement, interactor).element;
 }
-exports.resolveFirst = resolveFirst;
 // Given a parent element, and an interactor, check if there are any matching
 // elements, and throw an error if there are. Otherwise return undefined.
 function resolveEmpty(parentElement, interactor) {
     let matching = findMatches(parentElement, interactor).filter((m) => m.matches);
     if (matching.length !== 0) {
         let alternatives = matching.map((m) => '- ' + m.elementDescription());
-        throw new errors_1.NotAbsentError(`${(0, format_1.formatDescription)(interactor)} exists but should not:\n\n${alternatives.join('\n')}`);
+        throw new errors_js_1.NotAbsentError(`${(0, format_js_1.formatDescription)(interactor)} exists but should not:\n\n${alternatives.join('\n')}`);
     }
 }
-exports.resolveEmpty = resolveEmpty;
 function unsafeSyncResolveParent(options) {
     return options.ancestors.reduce(resolveUnique, globals_1.globals.document.documentElement);
 }
-exports.unsafeSyncResolveParent = unsafeSyncResolveParent;
 function unsafeSyncResolveUnique(options) {
     return resolveUnique(unsafeSyncResolveParent(options), options);
 }
-exports.unsafeSyncResolveUnique = unsafeSyncResolveUnique;
 //# sourceMappingURL=resolvers.js.map

package/script/src/resolvers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvers.js","sourceRoot":"","sources":["../../src/src/resolvers.ts"],"names":[],"mappings":";AACA,uDAAuD;;AAUvD,oCAYC;AA0BD,4CAEC;AAcD,sCASC;AAID,oCAEC;AAID,oCAOC;AAED,0DAEC;AAED,0DAEC;AAhGD,kDAA+C;AAC/C,yCAAmC;AACnC,2CAAwF;AACxF,2CAAoE;AAGpE,MAAM,eAAe,GAAG,KAAK,CAAC;AAE9B,SAAgB,YAAY,CAAoB,aAAsB,EAAE,UAA4C;IAClH,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,0KAA0K,CAAC,CAAC;IAC9L,CAAC;IACD,IAAI,OAAO,UAAU,CAAC,aAAa,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC5D,OAAO,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC1D,CAAC;SAAM,IAAI,UAAU,CAAC,aAAa,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QACzD,kGAAkG;QAClG,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAM,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,IAAI,eAAe,CAAC,CAAC,CAAC;IAC1G,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,aAAsB,EAAE,UAA4C;IACvF,OAAO,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,gBAAK,CAAC,CAAC,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AACjH,CAAC;AAED,SAAS,uBAAuB,CAAC,OAA8B,EAAE,UAA4C;IAC3G,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,8BAAkB,CAAC,gBAAgB,IAAA,6BAAiB,EAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChF,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,8BAAkB,CAAC,gBAAgB,IAAA,6BAAiB,EAAC,UAAU,CAAC,6BAA6B,IAAA,8BAAkB,EAAC,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;IACpJ,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,aAAsB,EAAE,UAA4C;IAC1F,IAAI,OAAO,GAA0B,EAAE,CAAA;IACvC,KAAK,IAAI,OAAO,IAAI,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,CAAC;QAC5D,IAAI,KAAK,GAAG,IAAI,gBAAK,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAA;QACrE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnB,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IACD,uBAAuB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAC/C,CAAC;AAED,SAAgB,gBAAgB,CAAC,aAAsB,EAAE,UAA4C;IACnG,OAAO,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,gBAAK,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;AACpI,CAAC;AAED,SAAS,mBAAmB,CAAC,aAAsB,EAAE,UAA4C;IAC/F,IAAI,OAAO,GAAG,WAAW,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACrD,IAAI,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,uBAAuB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAC/C,CAAC;AAED,+EAA+E;AAC/E,wEAAwE;AACxE,mCAAmC;AACnC,SAAgB,aAAa,CAAC,aAAsB,EAAE,UAA4C;IAChG,IAAI,QAAQ,GAAG,mBAAmB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAE9D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,IAAI,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC;QACtE,MAAM,IAAI,iCAAqB,CAAC,GAAG,IAAA,6BAAiB,EAAC,UAAU,CAAC,kCAAkC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/H,CAAC;AACH,CAAC;AAED,iFAAiF;AACjF,mDAAmD;AACnD,SAAgB,YAAY,CAAC,aAAsB,EAAE,UAA4C;IAC/F,OAAO,cAAc,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,OAAO,CAAA;AAC1D,CAAC;AAED,6EAA6E;AAC7E,yEAAyE;AACzE,SAAgB,YAAY,CAAC,aAAsB,EAAE,UAA4C;IAC/F,IAAI,QAAQ,GAAG,WAAW,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IAE9E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,IAAI,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC;QACtE,MAAM,IAAI,0BAAc,CAAC,GAAG,IAAA,6BAAiB,EAAC,UAAU,CAAC,8BAA8B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpH,CAAC;AACH,CAAC;AAED,SAAgB,uBAAuB,CAAC,OAAyC;IAC/E,OAAO,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,iBAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACnF,CAAC;AAED,SAAgB,uBAAuB,CAAoB,OAAuC;IAChG,OAAO,aAAa,CAAC,uBAAuB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAM,CAAC;AACvE,CAAC"}

package/script/src/serialize.d.ts

@@ -0,0 +1,13 @@
+import type { InteractionOptions as SerializedInteractionOptions, InteractionType } from "@interactors/globals";
+import type { InteractionOptions } from "./interaction.js";
+import type { InteractorOptions } from "./specification.js";
+export declare function serializeInteractorOptions(options: InteractorOptions<any, any, any>): {
+    interactor: string;
+    filter: {
+        [name: string]: unknown;
+    };
+    locator: string;
+    code: () => string;
+};
+export declare function serializeInteractionOptions<E extends Element, T>(type: InteractionType, { name, interactor: { options }, args, filters }: InteractionOptions<E, T>): SerializedInteractionOptions;
+//# sourceMappingURL=serialize.d.ts.map

package/script/src/serialize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize.d.ts","sourceRoot":"","sources":["../../src/src/serialize.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,IAAI,4BAA4B,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEhH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG;IACrF,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,MAAM,CAAC;CACpB,CAcA;AAED,wBAAgB,2BAA2B,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,EAC9D,IAAI,EAAE,eAAe,EACrB,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GACzE,4BAA4B,CAsB9B"}

package/{dist/cjs → script/src}/serialize.js

@@ -1,25 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeInteractionOptions = exports.serializeInteractorOptions = void 0;
+exports.serializeInteractorOptions = serializeInteractorOptions;
+exports.serializeInteractionOptions = serializeInteractionOptions;
 const change_case_1 = require("change-case");
-const matcher_1 = require("./matcher");
+const matcher_js_1 = require("./matcher.js");
 function serializeInteractorOptions(options) {
-    var _a;
-    let locator = (0, matcher_1.matcherCode)((_a = options.locator) === null || _a === void 0 ? void 0 : _a.value);
+    let locator = (0, matcher_js_1.matcherCode)(options.locator?.value);
     return {
         interactor: options.name,
         filter: options.filter.all,
         locator,
         code() {
             let interactorName = (0, change_case_1.pascalCase)(options.name);
-            let filters = Object.entries(options.filter.all).map(([name, filter]) => `"${name}": ${(0, matcher_1.matcherCode)(filter)}`);
+            let filters = Object.entries(options.filter.all).map(([name, filter]) => `"${name}": ${(0, matcher_js_1.matcherCode)(filter)}`);
             return `${interactorName}(${[locator, filters.length && `{ ${filters.join(", ")} }`]
                 .filter(Boolean)
                 .join(", ")})`;
         },
     };
 }
-exports.serializeInteractorOptions = serializeInteractorOptions;
 function serializeInteractionOptions(type, { name, interactor: { options }, args, filters }) {
     let interactor = serializeInteractorOptions(options);
     let ancestors = options.ancestors.map((ancestor) => serializeInteractorOptions(ancestor));
@@ -32,7 +31,7 @@ function serializeInteractionOptions(type, { name, interactor: { options }, args
         code() {
             let serializedArgs = "";
             if (filters) {
-                let serializedFilters = Object.entries(filters).map(([name, filter]) => `"${name}": ${(0, matcher_1.matcherCode)(filter)}`);
+                let serializedFilters = Object.entries(filters).map(([name, filter]) => `"${name}": ${(0, matcher_js_1.matcherCode)(filter)}`);
                 serializedArgs = `{ ${serializedFilters.join(", ")} }`;
             }
             else if (args) {
@@ -44,5 +43,4 @@ function serializeInteractionOptions(type, { name, interactor: { options }, args
         },
     };
 }
-exports.serializeInteractionOptions = serializeInteractionOptions;
 //# sourceMappingURL=serialize.js.map

package/script/src/serialize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize.js","sourceRoot":"","sources":["../../src/src/serialize.ts"],"names":[],"mappings":";;AAOA,gEAmBC;AAED,kEAyBC;AAnDD,6CAAyC;AAEzC,6CAA2C;AAG3C,SAAgB,0BAA0B,CAAC,OAAyC;IAMlF,IAAI,OAAO,GAAG,IAAA,wBAAW,EAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAClD,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,IAAI;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG;QAC1B,OAAO;QACP,IAAI;YACF,IAAI,cAAc,GAAG,IAAA,wBAAU,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,IAAA,wBAAW,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC9G,OAAO,GAAG,cAAc,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACjF,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACnB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,2BAA2B,CACzC,IAAqB,EACrB,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAA4B;IAE1E,IAAI,UAAU,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACrD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1F,OAAO;QACL,GAAG,UAAU;QACb,SAAS;QACT,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,IAAI;YACF,IAAI,cAAc,GAAG,EAAE,CAAC;YACxB,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,iBAAiB,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,IAAA,wBAAW,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAC7G,cAAc,GAAG,KAAK,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,CAAC;iBAAM,IAAI,IAAI,EAAE,CAAC;gBAChB,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrE,CAAC;YACD,OAAO,GAAG,CAAC,GAAG,SAAS,EAAE,UAAU,CAAC;iBACjC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC;iBAC9D,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,cAAc,GAAG,CAAC;QACjD,CAAC;KACF,CAAC;AACJ,CAAC"}

package/script/src/specification.d.ts

@@ -0,0 +1,216 @@
+import type { Operation } from '@effection/core';
+import type { FilterSet } from './filter-set.js';
+import type { Locator } from './locator.js';
+import type { ActionInteraction, AssertionInteraction } from './interaction.js';
+import type { MergeObjects } from './merge-objects.js';
+import type { MaybeMatcher } from './matcher.js';
+export type EmptyObject = Record<never, never>;
+/**
+ * Instances of an interactor returned by an {@link InteractorConstructor}, use
+ * this class as its base. They are also extended with any additional actions
+ * defined in their {@link InteractorSpecification}.
+ */
+export interface Interactor<E extends Element, F extends FilterParams<any, any>> {
+    /**
+     * @hidden
+     */
+    options: InteractorOptions<E, any, any>;
+    /**
+     * @returns a human readable description of this interactor
+     */
+    description: string;
+    /**
+     * Perform a one-off action on the given interactor. Takes a function which
+     * receives an element. This function converges, which means that it is rerun
+     * in a loop until it does not throw an error or times out.
+     *
+     * We recommend using this function for debugging only. You should normally
+     * define an action in an {@link InteractorSpecification}.
+     *
+     * ## Example
+     *
+     * ``` typescript
+     * await Link('Next').perform((e) => e.click());
+     * ```
+     */
+    perform(fn: (element: E) => void): ActionInteraction<E, void>;
+    /**
+     * Perform a one-off assertion on the given interactor. Takes a function which
+     * receives an element. This function converges, which means that it is rerun
+     * in a loop until it does not throw an error or times out.
+     *
+     * We recommend using this function for debugging only. You should normally
+     * define a filter in an {@link InteractorSpecification}.
+     *
+     * ## Example
+     *
+     * ``` typescript
+     * await Link('Next').assert((e) => assert(e.tagName === 'A'));
+     * ```
+     */
+    assert(fn: (element: E) => void): AssertionInteraction<E, void>;
+    /**
+     * An assertion which checks that an element matching the interactor exists.
+     * Throws an error if the element does not exist.
+     *
+     * ## Example
+     *
+     * ``` typescript
+     * await Link('Next').exists();
+     * ```
+     */
+    exists(): AssertionInteraction<E, void> & FilterObject<boolean, Element>;
+    /**
+     * An assertion which checks that an element matching the interactor does not
+     * exist. Throws an error if the element exists.
+     *
+     * ## Example
+     *
+     * ``` typescript
+     * await Link('Next').absent();
+     * ```
+     */
+    absent(): AssertionInteraction<E, void> & FilterObject<boolean, Element>;
+    /**
+     * Checks that there is one element matching the interactor, and that this
+     * element matches the given filters. The available filters are defined by
+     * the {@link InteractorSpecification}.
+     *
+     * ## Example
+     *
+     * ``` typescript
+     * await Link('Home').has({ href: '/' })
+     * ```
+     */
+    has(filters: F): AssertionInteraction<E, void>;
+    /**
+     * Identical to {@link has}, but reads better with some filters.
+     *
+     * ## Example
+     *
+     * ``` typescript
+     * await CheckBox('Accept conditions').is({ checked: true })
+     * ```
+     */
+    is(filters: F): AssertionInteraction<E, void>;
+    /**
+     * Returns a copy of the given interactor which is scoped to this interactor.
+     * When there are multiple matches for an interactor, this makes it possible
+     * to make them more specific by limiting the interactor to a section of the
+     * page.
+     *
+     * ## Example
+     *
+     * ``` typescript
+     * await Fieldset('Owner').find(TextField('Name')).fillIn('Jonas');
+     * await Fieldset('Brand').find(TextField('Name')).fillIn('Volkswagen');
+     * ```
+     * @param interactor the interactor which should be scoped
+     * @returns a scoped copy of the initial interactor
+     * @typeParam T the type of the interactor that we are going to scope
+     */
+    find<T extends Interactor<any, any>>(interactor: T): T;
+    /**
+     * @hidden
+     */
+    apply: FilterFn<string, Element>;
+}
+export type ActionFn<E extends Element, I extends Interactor<E, any>> = (interactor: I, ...args: any[]) => Operation<unknown>;
+export type FilterFn<T, E extends Element> = (element: E) => T;
+export type FilterObject<T, E extends Element> = {
+    apply: FilterFn<T, E>;
+    default?: T;
+};
+export type FilterDefinition<T, E extends Element> = FilterFn<T, E> | FilterObject<T, E>;
+export type Filters<E extends Element> = Record<string, FilterDefinition<unknown, E>>;
+export type Actions<E extends Element, I extends Interactor<E, any>> = Record<string, ActionFn<E, I>>;
+export type SelectorFn<E extends Element> = (parentElement: Element) => E[];
+export type InteractorSpecification<E extends Element, F extends Filters<E>, A extends Actions<E, Interactor<E, EmptyObject>>> = {
+    /**
+     * The CSS selector that this interactor uses to find matching elements
+     */
+    selector?: string | SelectorFn<E>;
+    actions?: A;
+    filters?: F;
+    /**
+     * A function which returns a string value for a matched element, which can
+     * be used to locate a specific instance of this interactor. The `value`
+     * parameter of an {@link InteractorConstructor} must match the value
+     * returned from the locator function.
+     */
+    locator?: FilterDefinition<string, E>;
+};
+export type ActionMethods<E extends Element, A extends Actions<E, I>, I extends Interactor<E, any>> = {
+    [P in keyof A]: A[P] extends ((interactor: I, ...args: infer TArgs) => Operation<infer TReturn>) ? ((...args: TArgs) => ActionInteraction<E, TReturn>) : never;
+};
+export type FilterMethods<E extends Element, F extends Filters<E>> = {
+    [P in keyof F]: F[P] extends FilterFn<infer TReturn, any> ? (() => AssertionInteraction<E, TReturn> & FilterObject<TReturn, Element>) : F[P] extends FilterObject<infer TReturn, any> ? (() => AssertionInteraction<E, TReturn> & FilterObject<TReturn, Element>) : never;
+};
+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 : {
+    [P in keyof F]?: F[P] extends FilterFn<infer TArg, E> ? MaybeMatcher<TArg> : F[P] extends FilterObject<infer TArg, E> ? MaybeMatcher<TArg> : never;
+};
+/**
+ * An interactor constructor is a function which can be used to initialize an
+ * {@link Interactor}. When calling {@link createInteractor}, you will get
+ * back an interactor constructor.
+ *
+ * The constructor can be called with a locator value, and an object of
+ * filters. Both are optional, and can be omitted.
+ *
+ * @typeParam E The type of DOM Element that this interactor operates on.
+ * @typeParam F the filters of this interactor, this is usually inferred from the specification
+ * @typeParam A the actions of this interactor, this is usually inferred from the specification
+ */
+export interface InteractorConstructor<E extends Element, FP extends FilterParams<any, any>, FM extends FilterMethods<any, any>, AM extends ActionMethods<any, any, any>> {
+    interactorName: string;
+    selector(value: string | SelectorFn<E>): InteractorConstructor<E, FP, FM, AM>;
+    locator(value: FilterDefinition<string, E>): InteractorConstructor<E, FP, FM, AM>;
+    filters<FR extends Filters<E>>(filters: FR): InteractorConstructor<E, MergeObjects<FP, FilterParams<E, FR>>, MergeObjects<FM, FilterMethods<E, FR>>, AM>;
+    actions<I extends Interactor<E, FP> & FM & AM, AR extends Actions<E, I>>(actions: AR): InteractorConstructor<E, FP, FM, MergeObjects<AM, ActionMethods<E, AR, I>>>;
+    extend<ER extends E = E>(name: string): InteractorConstructor<ER, FP, FM, AM>;
+    /**
+     * The constructor can be called with filters only:
+     *
+     * ``` typescript
+     * Link({ id: 'home-link', href: '/' });
+     * ```
+     *
+     * Or with no arguments, this can be especially useful when finding a nested element.
+     *
+     * ```
+     * ListItem('JavaScript').find(Link()).click(); // click the only link within a specific list item
+     * ```
+     *
+     * @param filters An object describing a set of filters to apply, which should match the value of applying the filters defined in the {@link InteractorSpecification} to the element.
+     */
+    (filters?: FP): Interactor<E, FP> & FM & AM;
+    /**
+     * The constructor can be called with a locator:
+     *
+     * ``` typescript
+     * Link('Home');
+     * Link(/^home/i);
+     * ```
+     *
+     * Or with a locator and options:
+     *
+     * ``` typescript
+     * Link('Home', { href: '/' });
+     * ```
+     *
+     * @param value The locator value, which should match the value of applying the locator function defined in the {@link InteractorSpecification} to the element.
+     * @param filters An object describing a set of filters to apply, which should match the value of applying the filters defined in the {@link InteractorSpecification} to the element.
+     */
+    (value: MaybeMatcher<string> | RegExp, filters?: FP): Interactor<E, FP> & FM & AM;
+}
+export type InteractorOptions<E extends Element, F extends Filters<E>, A extends Actions<E, Interactor<E, EmptyObject>>> = {
+    name: string;
+    specification: InteractorSpecification<E, F, A>;
+    locator?: Locator<E>;
+    filter: FilterSet<E, F>;
+    ancestors: InteractorOptions<any, any, any>[];
+};
+//# sourceMappingURL=specification.d.ts.map

package/script/src/specification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"specification.d.ts","sourceRoot":"","sources":["../../src/src/specification.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC;IAC7E;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAEvC;;OAEG;IACJ,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,GAAG,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAE9D;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,GAAG,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAEhE;;;;;;;;;OASG;IACH,MAAM,IAAI,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IACH,MAAM,IAAI,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEzE;;;;;;;;;;OAUG;IACH,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAE/C;;;;;;;;OAQG;IACH,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAE9C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC;IAEvD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC;AAE9H,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;AAE/D,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,IAAI;IAC/C,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACtB,OAAO,CAAC,EAAE,CAAC,CAAC;CACb,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEzF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;AAEtF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEtG,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,aAAa,EAAE,OAAO,KAAK,CAAC,EAAE,CAAC;AAE5E,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,IAAI;IAC/H;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,CAAC,EAAE,CAAC,CAAC;IACZ;;;;;OAKG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;CACvC,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI;KACnG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,KAAK,KAAK,SAAS,CAAC,MAAM,OAAO,CAAC,CAAC,GAC5F,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GACnD,KAAK;CACV,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,IAAI;KAClE,CAAC,IAAI,MAAM,CAAC,GACX,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,oBAAoB,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,GACrH,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,oBAAoB,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,GACzH,KAAK;CACR,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAChE,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG;KACjG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EACb,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,GACzD,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,GAC7D,KAAK;CACR,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACtK,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC9E,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAClF,OAAO,CAAC,EAAE,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,qBAAqB,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACzJ,OAAO,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,qBAAqB,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,YAAY,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACnK,MAAM,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAE9E;;;;;;;;;;;;;;OAcG;IACH,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;CACnF;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,IAAI;IACzH,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAChD,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACrB,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxB,SAAS,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/C,CAAC"}

package/script/src/specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"specification.js","sourceRoot":"","sources":["../../src/src/specification.ts"],"names":[],"mappings":";AAAA,uDAAuD"}

package/src/mod.ts

@@ -0,0 +1 @@
+export * from './src/index.js'

package/src/{constructor.ts → src/constructor.ts}

@@ -1,8 +1,8 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
-import { converge } from './converge';
-import { MergeObjects } from './merge-objects';
-import {
+import { converge } from './converge.js';
+import type { MergeObjects } from './merge-objects.js';
+import type {
   InteractorOptions,
   ActionMethods,
   InteractorConstructor,
@@ -14,16 +14,17 @@ import {
   FilterMethods,
   InteractorSpecification,
   FilterObject,
-} from './specification';
-import { FilterSet } from './filter-set';
-import { Locator } from './locator';
-import { MatchFilter, applyFilter } from './match';
-import { formatDescription } from './format';
-import { FilterNotMatchingError } from './errors';
-import { createInteraction, AssertionInteraction, ActionInteraction } from './interaction';
-import { isMatcher } from './matcher';
-import { matching } from './matchers/matching';
-import { hasMatchMatching, resolveEmpty, resolveFirst, resolveUnique, unsafeSyncResolveParent, unsafeSyncResolveUnique } from './resolvers';
+} from './specification.js';
+import { FilterSet } from './filter-set.js';
+import { Locator } from './locator.js';
+import { MatchFilter, applyFilter } from './match.js';
+import { formatDescription } from './format.js';
+import { FilterNotMatchingError } from './errors.js';
+import { createInteraction, type AssertionInteraction, type ActionInteraction } from './interaction.js';
+import { isMatcher } from './matcher.js';
+import { matching } from './matchers/matching.js';
+import { hasMatchMatching, resolveEmpty, resolveFirst, resolveUnique, unsafeSyncResolveParent, unsafeSyncResolveUnique } from './resolvers.js';
+import { defineInteractorConstructorMetadata } from "./metadata.js";
 
 const defaultLocator: FilterDefinition<string, Element> = (element) => element.textContent || "";
 
@@ -137,7 +138,7 @@ export function instantiateInteractor<E extends Element, F extends Filters<E>, A
   };
 
   for (let [actionName, action] of Object.entries(options.specification.actions || {})) {
-    if (!interactor.hasOwnProperty(actionName)) {
+    if (!Object.prototype.hasOwnProperty.call(interactor, actionName)) {
       Object.defineProperty(interactor, actionName, {
         value: function(...args: unknown[]) {
           let actionDescription = actionName;
@@ -160,7 +161,7 @@ export function instantiateInteractor<E extends Element, F extends Filters<E>, A
   }
 
   for (let [filterName, filter] of Object.entries(options.specification.filters || {})) {
-    if (!interactor.hasOwnProperty(filterName)) {
+    if (!Object.prototype.hasOwnProperty.call(interactor, filterName)) {
       Object.defineProperty(interactor, filterName, {
         value: function() {
           return createInteraction('assertion', {
@@ -200,7 +201,7 @@ export function createConstructor<E extends Element, FP extends FilterParams<any
     return instantiateInteractor({ name, specification, filter, locator, ancestors: [] }, unsafeSyncResolveUnique);
   }
 
-  return Object.assign(initInteractor, {
+  let constructor = Object.assign(initInteractor, {
     interactorName: name,
     selector: (value: string): InteractorConstructor<E, FP, FM, AM> => {
       return createConstructor(name, { ...specification, selector: value });
@@ -218,4 +219,12 @@ export function createConstructor<E extends Element, FP extends FilterParams<any
       return createConstructor(newName, specification) as unknown as InteractorConstructor<ER, FP, FM, AM>;
     },
   }) as unknown as InteractorConstructor<E, FP, FM, AM>;
+
+  defineInteractorConstructorMetadata(constructor, {
+    name,
+    actions: Object.keys(specification.actions ?? {}),
+    filters: Object.keys(specification.filters ?? {}),
+  });
+
+  return constructor;
 }

package/src/{converge.ts → src/converge.ts}

@@ -1,4 +1,4 @@
-import { Operation, sleep } from '@effection/core';
+import { type Operation, sleep } from '@effection/core';
 import { performance } from 'performance-api';
 import { globals } from '@interactors/globals'
 

package/src/{create-interactor.ts → src/create-interactor.ts}

@@ -1,5 +1,5 @@
-import { EmptyObject, InteractorConstructor } from './specification';
-import { createConstructor } from './constructor';
+import type { EmptyObject, InteractorConstructor } from './specification.js';
+import { createConstructor } from './constructor.js';
 
 /**
  * Create a custom interactor with the given name.

package/src/src/element/click.ts

@@ -0,0 +1,5 @@
+import { userEvent } from '@testing-library/user-event'
+
+export function click(...args: Parameters<typeof userEvent.click>): ReturnType<typeof userEvent.click> {
+  return userEvent.click(...args);
+}