@ripplo/testing 0.6.0 → 0.7.0

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@ripplo/testing",
-  "description": "TypeScript DSL for defining and running Ripplo e2e workflow tests",
-  "version": "0.6.0",
+  "version": "0.7.0",
+  "description": "Typed test DSL for Ripplo — declare entities and user flows, compile to a lockfile",
+  "homepage": "https://ripplo.ai",
+  "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "DSL.md"
   ],
   "exports": {
     ".": {
@@ -12,136 +15,51 @@
       "import": "./dist/index.js",
       "default": "./dist/index.js"
     },
-    "./actions": {
-      "types": "./dist/actions.d.ts",
-      "import": "./dist/actions.js",
-      "default": "./dist/actions.js"
-    },
-    "./assert": {
-      "types": "./dist/assert.d.ts",
-      "import": "./dist/assert.js",
-      "default": "./dist/assert.js"
-    },
-    "./control": {
-      "types": "./dist/control.d.ts",
-      "import": "./dist/control.js",
-      "default": "./dist/control.js"
-    },
-    "./locators": {
-      "types": "./dist/locators.d.ts",
-      "import": "./dist/locators.js",
-      "default": "./dist/locators.js"
-    },
-    "./compiler": {
-      "types": "./dist/compiler.d.ts",
-      "import": "./dist/compiler.js",
-      "default": "./dist/compiler.js"
-    },
-    "./lockfile": {
-      "types": "./dist/lockfile.d.ts",
-      "import": "./dist/lockfile.js",
-      "default": "./dist/lockfile.js"
-    },
-    "./elysia": {
-      "types": "./dist/elysia.d.ts",
-      "import": "./dist/elysia.js",
-      "default": "./dist/elysia.js"
-    },
     "./express": {
       "types": "./dist/express.d.ts",
       "import": "./dist/express.js",
       "default": "./dist/express.js"
-    },
-    "./fastify": {
-      "types": "./dist/fastify.d.ts",
-      "import": "./dist/fastify.js",
-      "default": "./dist/fastify.js"
-    },
-    "./hono": {
-      "types": "./dist/hono.d.ts",
-      "import": "./dist/hono.js",
-      "default": "./dist/hono.js"
-    },
-    "./koa": {
-      "types": "./dist/koa.d.ts",
-      "import": "./dist/koa.js",
-      "default": "./dist/koa.js"
-    },
-    "./nestjs": {
-      "types": "./dist/nestjs.d.ts",
-      "import": "./dist/nestjs.js",
-      "default": "./dist/nestjs.js"
-    },
-    "./nextjs": {
-      "types": "./dist/nextjs.d.ts",
-      "import": "./dist/nextjs.js",
-      "default": "./dist/nextjs.js"
     }
   },
   "dependencies": {
+    "neverthrow": "^8.2.0",
     "standardwebhooks": "^1.0.0",
-    "zod": "^4.3.6"
-  },
-  "devDependencies": {
-    "@nestjs/common": "^10.0.0",
-    "@nestjs/core": "^10.0.0",
-    "@types/express": "^5.0.2",
-    "@types/koa": "^2.15.0",
-    "@types/node": "catalog:",
-    "elysia": "^1.0.0",
-    "eslint": "catalog:",
-    "express": "^5.1.0",
-    "fastify": "^5.3.3",
-    "hono": "^4.0.0",
-    "koa": "^2.15.0",
-    "reflect-metadata": "^0.2.0",
-    "rxjs": "^7.8.0",
-    "tsup": "^8.5.1",
-    "typescript": "catalog:",
-    "vitest": "^4.1.4",
-    "@ripplo/eslint-config": "0.0.0",
-    "@ripplo/spec": "^0.0.0"
+    "zod": "4.3.6"
   },
   "peerDependencies": {
-    "@nestjs/common": "^10.0.0 || ^11.0.0",
-    "@nestjs/core": "^10.0.0 || ^11.0.0",
-    "dotenv": "^16.0.0 || ^17.0.0",
-    "elysia": "^1.0.0",
-    "express": "^4.0.0 || ^5.0.0",
-    "fastify": "^5.0.0",
-    "hono": "^4.0.0",
-    "koa": "^2.0.0 || ^3.0.0"
+    "express": "^4.0.0 || ^5.0.0"
   },
   "peerDependenciesMeta": {
-    "@nestjs/common": {
-      "optional": true
-    },
-    "@nestjs/core": {
-      "optional": true
-    },
-    "dotenv": {
-      "optional": true
-    },
-    "elysia": {
-      "optional": true
-    },
     "express": {
       "optional": true
-    },
-    "fastify": {
-      "optional": true
-    },
-    "hono": {
-      "optional": true
-    },
-    "koa": {
-      "optional": true
     }
   },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.15.3",
+    "eslint": "^9.39.1",
+    "eslint-plugin-neverthrow": "^1.1.4",
+    "express": "^5.1.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.4",
+    "@ripplo/eslint-config": "0.0.0",
+    "@ripplo/spec": "^0.0.0"
+  },
   "scripts": {
     "build": "tsup",
     "check-types": "tsc --noEmit",
     "lint": "eslint src",
     "test": "vitest run"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "express": [
+        "./dist/express.d.ts"
+      ]
+    }
   }
 }

package/dist/actions.d.ts

@@ -1,260 +0,0 @@
-import { Variable, StaticStringRef, VariableRef } from './control.js';
-import { U as UnlabeledStep } from './step-De52hTLd.js';
-import { CheckLocator, InputLocator, AnyLocator, SelectLocator } from './locators.js';
-import '@ripplo/spec';
-
-declare class Fixture {
-    readonly kind: "fixture";
-    readonly name: string;
-    constructor(name: string);
-}
-declare function fixture(name: string): Fixture;
-declare function isFixture(value: unknown): value is Fixture;
-
-type StringOrVariable = string | Variable<string>;
-declare function navigate(url: string): UnlabeledStep<{
-    type: "goto";
-    url: {
-        type: "static";
-        value: string;
-    };
-}>;
-interface StepOptions {
-    readonly modifier?: "Alt" | "Control" | "Meta" | "Shift";
-    readonly uiOnly?: boolean;
-}
-declare function click(locator: AnyLocator, options?: StepOptions): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    modifier: "Alt" | "Control" | "Meta" | "Shift" | undefined;
-    type: "click";
-    uiOnly: boolean | undefined;
-}>;
-declare function fill(locator: InputLocator, value: StringOrVariable): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "fill";
-    value: StaticStringRef | VariableRef;
-}>;
-declare function select(locator: SelectLocator, value: StringOrVariable): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "select";
-    value: StaticStringRef | VariableRef;
-}>;
-declare function check(locator: CheckLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "check";
-}>;
-declare function uncheck(locator: CheckLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "uncheck";
-}>;
-declare function hover(locator: AnyLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "hover";
-}>;
-declare function press(key: string): UnlabeledStep<{
-    key: string;
-    type: "press";
-}>;
-declare function upload(locator: AnyLocator, files: Fixture | ReadonlyArray<Fixture>, options?: StepOptions): UnlabeledStep<{
-    files: string[];
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "upload";
-    uiOnly: boolean | undefined;
-}>;
-declare function dblclick(locator: AnyLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "dblclick";
-}>;
-declare function focus(locator: AnyLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "focus";
-}>;
-declare function clear(locator: InputLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "clear";
-}>;
-declare function typeText(locator: InputLocator, value: StringOrVariable): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "type";
-    value: StaticStringRef | VariableRef;
-}>;
-declare function rightClick(locator: AnyLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "rightClick";
-}>;
-declare function scrollIntoView(locator: AnyLocator): UnlabeledStep<{
-    locator: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "scrollIntoView";
-}>;
-declare function drag(source: AnyLocator, target: AnyLocator): UnlabeledStep<{
-    source: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    target: {
-        by: "testId";
-        value: string;
-    } | {
-        by: "role";
-        role: string;
-        name?: string | undefined;
-    };
-    type: "drag";
-}>;
-interface HandleDialogOptions {
-    readonly action: "accept" | "dismiss";
-    readonly promptText: string | undefined;
-    readonly uiOnly?: boolean;
-}
-/**
- * Register a one-shot listener for the next native dialog (`alert`, `confirm`,
- * `prompt`). Pure client-side — the backend mutation, if any, comes from the
- * triggering action; observer assertions belong on that step, not here.
- */
-declare function handleDialog({ action, promptText, uiOnly }: HandleDialogOptions): UnlabeledStep<{
-    action: "accept" | "dismiss";
-    promptText: string | undefined;
-    type: "handleDialog";
-    uiOnly: boolean | undefined;
-}>;
-interface ClipboardOptions {
-    readonly action: "read" | "write";
-    readonly target: Variable<string> | undefined;
-    readonly value: StringOrVariable | undefined;
-}
-/**
- * Read from or write to the browser clipboard. Use when a flow depends on
- * copy/paste (share links, invite tokens) — pair `write` to seed the
- * clipboard before a paste action, or `read` into a `variable()` to assert
- * what the app copied.
- */
-declare function clipboard({ action, target, value }: ClipboardOptions): UnlabeledStep<{
-    action: "read" | "write";
-    type: "clipboard";
-    value: StaticStringRef | VariableRef | undefined;
-    variable: string | undefined;
-}>;
-interface SetPermissionOptions {
-    readonly permission: string;
-    readonly state: "granted" | "prompt";
-}
-/**
- * Pre-answer a browser permission prompt (geolocation, camera, notifications,
- * clipboard-read, etc.) so the test doesn't stall on the native dialog.
- */
-declare function setPermission({ permission, state }: SetPermissionOptions): UnlabeledStep<{
-    permission: string;
-    state: "granted" | "prompt";
-    type: "setPermission";
-}>;
-interface SetViewportOptions {
-    readonly height: number;
-    readonly width: number;
-}
-/**
- * Resize the browser viewport mid-test. Use to cover responsive breakpoints
- * (mobile nav, collapsed sidebars) within the same flow rather than
- * duplicating the test per size.
- */
-declare function setViewport({ height, width }: SetViewportOptions): UnlabeledStep<{
-    height: number;
-    type: "setViewport";
-    width: number;
-}>;
-
-export { Fixture, check, clear, click, clipboard, dblclick, drag, fill, fixture, focus, handleDialog, hover, isFixture, navigate, press, rightClick, scrollIntoView, select, setPermission, setViewport, typeText, uncheck, upload };

package/dist/actions.js

@@ -1,177 +0,0 @@
-import {
-  readVariable,
-  toSpecLocator,
-  toStringValueRef
-} from "./chunk-2YLI7VD4.js";
-import "./chunk-DCJBLS2U.js";
-import {
-  createStep
-} from "./chunk-MGATMMCZ.js";
-import "./chunk-4MGIQFAJ.js";
-
-// src/steps/fixture.ts
-var Fixture = class {
-  kind = "fixture";
-  name;
-  constructor(name) {
-    const raw = name;
-    if (typeof raw !== "string") {
-      throw new TypeError(
-        `fixture(name) requires a string name \u2014 got ${raw == null ? String(raw) : typeof raw}`
-      );
-    }
-    if (raw.length === 0) {
-      throw new Error("fixture(name) requires a non-empty name");
-    }
-    this.name = raw;
-  }
-};
-function fixture(name) {
-  return new Fixture(name);
-}
-function isFixture(value) {
-  return value instanceof Fixture;
-}
-
-// src/steps/actions.ts
-function navigate(url) {
-  return createStep({ type: "goto", url: { type: "static", value: url } });
-}
-function click(locator, options) {
-  return createStep({
-    locator: toSpecLocator(locator),
-    modifier: options?.modifier,
-    type: "click",
-    uiOnly: options?.uiOnly
-  });
-}
-function fill(locator, value) {
-  return createStep({
-    locator: toSpecLocator(locator),
-    type: "fill",
-    value: toStringValueRef(value)
-  });
-}
-function select(locator, value) {
-  return createStep({
-    locator: toSpecLocator(locator),
-    type: "select",
-    value: toStringValueRef(value)
-  });
-}
-function check(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "check" });
-}
-function uncheck(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "uncheck" });
-}
-function hover(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "hover" });
-}
-function press(key) {
-  return createStep({ key, type: "press" });
-}
-function describeFilesArg(files) {
-  if (typeof files === "string") {
-    return `string "${files}"`;
-  }
-  return typeof files;
-}
-function normalizeUploadFiles(files) {
-  if (files instanceof Fixture) {
-    return [files];
-  }
-  if (!Array.isArray(files)) {
-    throw new TypeError(
-      `upload() expected a Fixture or an array of Fixtures \u2014 got ${describeFilesArg(files)}. Wrap the filename with fixture(): upload(loc, fixture("file.png"))`
-    );
-  }
-  return files.map((f, i) => {
-    if (!(f instanceof Fixture)) {
-      throw new TypeError(
-        `upload() files[${String(i)}] is not a Fixture \u2014 wrap it with fixture(): upload(loc, fixture("file.png"))`
-      );
-    }
-    return f;
-  });
-}
-function upload(locator, files, options) {
-  const list = normalizeUploadFiles(files);
-  return createStep({
-    files: list.map((f) => f.name),
-    locator: toSpecLocator(locator),
-    type: "upload",
-    uiOnly: options?.uiOnly
-  });
-}
-function dblclick(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "dblclick" });
-}
-function focus(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "focus" });
-}
-function clear(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "clear" });
-}
-function typeText(locator, value) {
-  return createStep({
-    locator: toSpecLocator(locator),
-    type: "type",
-    value: toStringValueRef(value)
-  });
-}
-function rightClick(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "rightClick" });
-}
-function scrollIntoView(locator) {
-  return createStep({ locator: toSpecLocator(locator), type: "scrollIntoView" });
-}
-function drag(source, target) {
-  return createStep({
-    source: toSpecLocator(source),
-    target: toSpecLocator(target),
-    type: "drag"
-  });
-}
-function handleDialog({ action, promptText, uiOnly }) {
-  return createStep({ action, promptText, type: "handleDialog", uiOnly });
-}
-function clipboard({ action, target, value }) {
-  return createStep({
-    action,
-    type: "clipboard",
-    value: value == null ? void 0 : toStringValueRef(value),
-    variable: target == null ? void 0 : readVariable(target)
-  });
-}
-function setPermission({ permission, state }) {
-  return createStep({ permission, state, type: "setPermission" });
-}
-function setViewport({ height, width }) {
-  return createStep({ height, type: "setViewport", width });
-}
-export {
-  Fixture,
-  check,
-  clear,
-  click,
-  clipboard,
-  dblclick,
-  drag,
-  fill,
-  fixture,
-  focus,
-  handleDialog,
-  hover,
-  isFixture,
-  navigate,
-  press,
-  rightClick,
-  scrollIntoView,
-  select,
-  setPermission,
-  setViewport,
-  typeText,
-  uncheck,
-  upload
-};