@ripplo/testing 0.6.1 → 0.7.0

package/dist/index.d.ts

@@ -1,59 +1,122 @@
-export { C as CoverageRegistry, O as ObserverImplFn, a as ObserverRegistry, P as PreconditionImpl, b as PreconditionRecord, c as PreconditionRegistry, d as PreconditionSetupItem, e as PreconditionTeardownItem, R as ResolveDeps, f as RipploBuilder, g as RipploInstance, h as RipploRegistries, i as createRipplo, o as observer, p as precondition, t as test } from './builder-SsgqYqSC.js';
-import { CompileResult } from './compiler.js';
-export { CompiledTest, compile } from './compiler.js';
-import { E as EngineRunResult, T as TeardownRunResult$1 } from './engine-BOqzK_go.js';
-export { a as EngineImpls, b as ExecuteBatchItem, c as ExecuteBatchOptions, N as NotImplemented, O as ObserverImplFnFor, P as PreconditionImplFor, R as RipploEngine, d as TEST_ID_PREFIX, e as TeardownBatchItem, f as createEngine, n as notImplemented } from './engine-BOqzK_go.js';
-import { C as CookieEntry } from './types-BzZrl65Z.js';
-export { c as CookieOptions, D as DEFAULT_IGNORE_PATHS, d as DEFAULT_WATCH_PATHS, e as ObserverContext, f as ObserverDefinition, O as ObserverHandle, a as ObserverInput, g as ObserverOutcome, h as Precondition, i as PreconditionDeps, P as Primitive, S as SetupContext, T as TeardownContext, j as TestDefinition, k as TestValue } from './types-BzZrl65Z.js';
-export { D as DslNodeInput } from './step-De52hTLd.js';
-import '@ripplo/spec';
-
-interface LintDiagnostic {
-    readonly message: string;
-    readonly rule: string;
-    readonly step: string | undefined;
-    readonly test: string;
-}
-interface LintResult {
-    readonly diagnostics: ReadonlyArray<LintDiagnostic>;
-}
-declare function lint(result: CompileResult): LintResult;
-
-declare function readAdapterWebhookSecret(): string;
-interface SerializedCookie {
-    readonly domain: string | undefined;
-    readonly expires: number | undefined;
-    readonly httpOnly: boolean | undefined;
-    readonly name: string;
-    readonly path: string | undefined;
-    readonly sameSite: "lax" | "none" | "strict" | undefined;
-    readonly secure: boolean | undefined;
-    readonly value: string;
-}
-type BatchRunResult = {
-    readonly cookies: ReadonlyArray<SerializedCookie>;
-    readonly data: Record<string, Record<string, string | number | boolean>>;
-    readonly executed: ReadonlyArray<string>;
-    readonly ok: true;
-    readonly runId: string;
-} | {
-    readonly error: string;
-    readonly ok: false;
-    readonly runId: string;
-};
-type TeardownRunResult = {
-    readonly error: string | undefined;
-    readonly ok: boolean;
-    readonly runId: string;
-};
-interface WebhookHeaders {
-    readonly "webhook-id": string | undefined;
-    readonly "webhook-signature": string | undefined;
-    readonly "webhook-timestamp": string | undefined;
-}
-declare function verifyWebhookSignature(payload: string, headers: WebhookHeaders, secret: string): boolean;
-declare function serializeCookie(cookie: CookieEntry): SerializedCookie;
-declare function toBatchRunResults(results: ReadonlyArray<EngineRunResult>): ReadonlyArray<BatchRunResult>;
-declare function toTeardownResults(results: ReadonlyArray<TeardownRunResult$1>): ReadonlyArray<TeardownRunResult>;
-
-export { CompileResult, CookieEntry, EngineRunResult, type LintDiagnostic, type LintResult, type SerializedCookie, TeardownRunResult$1 as TeardownRunResult, lint, readAdapterWebhookSecret, serializeCookie, toBatchRunResults, toTeardownResults, verifyWebhookSignature };
+import { C as Capture, S as Step, P as PredicateInput, L as Locator, B as Binding, A as AnyBinding, G as GivenItem, T as Test, a as EntityList, b as SingletonList, c as Lockfile, U as UniqueNames, d as BrowserSingleton, e as LeafPredicate, f as Primitive, F as FieldHandle, D as DeclSource, R as Row, g as Primitive$1, h as SingletonDef } from './engine-BT7hUouB.js';
+export { i as AbsenceHandle, j as CLIENT_MOUNT_KEY, k as CLIENT_SEED_KEY, l as ConditionInput, m as ConditionPredicate, n as CountCondition, o as DuplicateEntityName, E as Engine, p as EngineError, q as EngineImpls, r as EngineRead, s as EntityDef, t as EntityHandle, u as EntityImpl, v as FieldOptions, w as Fields, H as Handle, x as Selection, y as SingletonConfig, z as SingletonImpl, I as SingletonValue, W as WhenClause, J as WithinMatcher, K as and, M as changed, N as count, O as createEngine, Q as disabled, V as enabled, X as entity, Y as field, Z as focused, _ as id, $ as key, a0 as not, a1 as singleton, a2 as text, a3 as v, a4 as value, a5 as visible, a6 as when, a7 as within } from './engine-BT7hUouB.js';
+import 'neverthrow';
+import 'zod';
+
+interface StepBuilder {
+    readonly captures: ReadonlyArray<Capture>;
+    readonly step: Step;
+    readonly expect: (...predicates: ReadonlyArray<PredicateInput>) => StepBuilder;
+}
+declare function goto(strings: TemplateStringsArray, ...values: readonly AnyBinding[]): StepBuilder;
+declare function click(locator: Locator): StepBuilder;
+declare function dblclick(locator: Locator): StepBuilder;
+declare function fill(locator: Locator, binding: Binding<string> | string): StepBuilder;
+declare function clear(locator: Locator): StepBuilder;
+declare function select(locator: Locator, binding: Binding<string> | string): StepBuilder;
+declare function check(locator: Locator): StepBuilder;
+declare function uncheck(locator: Locator): StepBuilder;
+declare function hover(locator: Locator): StepBuilder;
+declare function upload(locator: Locator, files: ReadonlyArray<string>): StepBuilder;
+declare function press(pressKey: string, locator?: Locator): StepBuilder;
+
+interface TestBody {
+    readonly given: ReadonlyArray<GivenItem>;
+    readonly steps: ReadonlyArray<StepBuilder>;
+}
+
+interface RipploTest {
+    readonly spec: Test;
+}
+declare function test(intent: string, fn?: () => TestBody): RipploTest;
+
+interface RipploInput<S extends EntityList, Sg extends SingletonList> {
+    readonly entities: S & UniqueNames<S>;
+    readonly singletons: Sg;
+    readonly tests: ReadonlyArray<RipploTest>;
+}
+interface Ripplo<S extends EntityList, Sg extends SingletonList> {
+    readonly entities: S;
+    readonly lockfile: Lockfile;
+    readonly singletons: Sg;
+    readonly tests: ReadonlyArray<RipploTest>;
+}
+declare function createRipplo<const S extends EntityList, const Sg extends SingletonList>(input: RipploInput<S, Sg>): Ripplo<S, Sg>;
+
+type LocatorName = string | Binding<string> | TemplateStringsArray;
+type NamedLocator = (name: LocatorName, ...bindings: ReadonlyArray<AnyBinding>) => Locator;
+type ContainerLocator = (name?: LocatorName, ...bindings: ReadonlyArray<AnyBinding>) => Locator;
+declare function role(roleName: string, name?: LocatorName, ...bindings: ReadonlyArray<AnyBinding>): Locator;
+declare function inside(scope: Locator, target: Locator): Locator;
+declare function testId(value: string | TemplateStringsArray, ...bindings: ReadonlyArray<AnyBinding>): Locator;
+declare const button: NamedLocator;
+declare const cell: NamedLocator;
+declare const checkbox: NamedLocator;
+declare const combobox: NamedLocator;
+declare const dialog: NamedLocator;
+declare const heading: NamedLocator;
+declare const img: NamedLocator;
+declare const link: NamedLocator;
+declare const listitem: NamedLocator;
+declare const menuitem: NamedLocator;
+declare const option: NamedLocator;
+declare const radio: NamedLocator;
+declare const row: NamedLocator;
+declare const searchbox: NamedLocator;
+declare const tab: NamedLocator;
+declare const textbox: NamedLocator;
+declare const alert: ContainerLocator;
+declare const banner: ContainerLocator;
+declare const complementary: ContainerLocator;
+declare const contentinfo: ContainerLocator;
+declare const form: ContainerLocator;
+declare const list: ContainerLocator;
+declare const main: ContainerLocator;
+declare const menu: ContainerLocator;
+declare const navigation: ContainerLocator;
+declare const region: ContainerLocator;
+declare const status: ContainerLocator;
+declare const table: ContainerLocator;
+declare const tablist: ContainerLocator;
+
+interface BrowserSingletonDef<Name extends BrowserSingleton> {
+    readonly name: Name;
+    readonly is: (strings: TemplateStringsArray, ...values: readonly Binding<string>[]) => LeafPredicate;
+}
+declare const url: BrowserSingletonDef<"url">;
+declare const title: BrowserSingletonDef<"title">;
+declare const viewport: BrowserSingletonDef<"viewport">;
+
+declare function arbitrary<T extends Primitive>(field: FieldHandle<T>, example?: T): Binding<T>;
+
+interface ClientSingletonImpl<T extends Primitive$1> {
+    readonly read: () => T | null;
+    readonly seed: (value: T) => void;
+}
+interface ClientEntityImpl {
+    readonly read: () => ReadonlyArray<Row>;
+}
+type ValueOf<D> = D extends SingletonDef<string, infer T> ? T : Primitive$1;
+interface ClientEngineImpls<R extends DeclSource> {
+    readonly entities: {
+        readonly [D in Extract<R["entities"][number], {
+            readonly source: "client";
+        }> as D["name"]]: ClientEntityImpl;
+    };
+    readonly singletons: {
+        readonly [D in Extract<R["singletons"][number], {
+            readonly source: "client";
+        }> as D["name"]]: ClientSingletonImpl<ValueOf<D>>;
+    };
+}
+interface ClientEngineMount {
+    readonly readEntity: (name: string) => ReadonlyArray<Row>;
+    readonly readSingleton: (name: string) => Primitive$1 | null;
+}
+declare function createClientEngine<R extends DeclSource>(_ripplo: R, impls: ClientEngineImpls<R>): ClientEngineMount;
+interface MountClientEngineOptions {
+    readonly enabled: boolean;
+}
+declare function mountClientEngine<R extends DeclSource>(ripplo: R, impls: ClientEngineImpls<R>, { enabled }: MountClientEngineOptions): void;
+
+export { AnyBinding, Binding, type BrowserSingletonDef, type ClientEngineImpls, type ClientEngineMount, type ClientEntityImpl, type ClientSingletonImpl, type ContainerLocator, EntityList, FieldHandle, GivenItem, type LocatorName, type MountClientEngineOptions, type NamedLocator, Primitive, type Ripplo, type RipploTest, SingletonDef, SingletonList, type TestBody, UniqueNames, alert, arbitrary, banner, button, cell, check, checkbox, clear, click, combobox, complementary, contentinfo, createClientEngine, createRipplo, dblclick, dialog, fill, form, goto, heading, hover, img, inside, link, list, listitem, main, menu, menuitem, mountClientEngine, navigation, option, press, radio, region, role, row, searchbox, select, status, tab, table, tablist, test, testId, textbox, title, uncheck, upload, url, viewport };