@revyl/verify 0.0.0-stage → 0.2.0

package/docs/web.md

@@ -0,0 +1,37 @@
+# Web
+
+A web target opens your app in a Revyl cloud browser.
+
+```ts
+{
+  platform: 'web',
+  app: { appId: '…', url: 'https://pr-123.preview.example.com' },
+  viewport: { width: 1440, height: 900 },
+}
+```
+
+## What it opens
+
+- With `app.url`, each `open()` registers the URL as a build of the Revyl app (on `app.branch` when set) and opens it. The URL must be public HTTPS; Revyl's browser cannot reach `localhost` or a private network.
+- With `app.buildId`, it opens that exact build.
+- With neither, it opens the newest web build of the app, on `app.branch` when set and otherwise on the app's default branch.
+
+## Signing in
+
+Most apps need a signed-in user. Revyl can open a test-only sign-in route before the session starts, so the session begins signed in:
+
+```ts
+signIn: { path: '/__test/sign-in', secret: 'E2E_SIGN_IN_TOKEN', persona: 'admin' }
+```
+
+`secret` is the **name** of an organization secret in Revyl, never its value. Revyl sends the secret's value to `path` on your app, which should sign in a test user and redirect. Keep that route disabled in production.
+
+## Steps on web
+
+`instruction` and `validation` use the same Revyl endpoints on web as on iOS and Android, and each step shows up in the session's report.
+
+Production is the default. **Optional staging access** is for users with an approved early-access organization and matching credentials; it is not required for normal setup. Get your endpoints from Revyl, set `REVYL_BACKEND_URL` and the matching `REVYL_APP_URL`, and authenticate for that environment. Never mix production and early-access credentials.
+
+A Revyl backend that does not run steps on web yet answers with `step_output_not_available`, which Verify reports as `NOT_AVAILABLE_ON_PLATFORM`. The same script works there with no change once it does. `open`, `screenshot`, `viewerUrl`, and `close` work on web everywhere.
+
+Revyl runs one step at a time on a session. A step sent while another is still running, for example one that just timed out and is still being cancelled, fails with `SESSION_BUSY`.

package/package.json

@@ -1,6 +1,73 @@
 {
   "name": "@revyl/verify",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Open Revyl cloud browsers and mobile devices for agent steps, or Mac and Linux computers for commands and files, from TypeScript.",
+  "keywords": [
+    "e2e",
+    "end-to-end",
+    "mobile",
+    "ios",
+    "android",
+    "web",
+    "macos",
+    "linux",
+    "ai",
+    "agent",
+    "revyl"
+  ],
+  "homepage": "https://github.com/RevylAI/verify#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RevylAI/verify.git",
+    "directory": "packages/verify"
+  },
+  "bugs": {
+    "url": "https://github.com/RevylAI/verify/issues"
+  },
+  "license": "Apache-2.0",
+  "author": "Revyl <support@revyl.ai>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "verify": "./dist/cli/main.js",
+    "revyl-verify": "./dist/cli/main.js"
+  },
+  "files": [
+    "dist",
+    "docs",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "SECURITY.md"
+  ],
+  "engines": {
+    "node": ">=22.18"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && chmod +x dist/cli/main.js",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "prepack": "npm run build && node ../../scripts/prepare-package.mjs"
+  },
+  "dependencies": {
+    "jiti": "^2.6.0",
+    "pngjs": "^7.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "@types/pngjs": "^6.0.5",
+    "typescript": "^5.9.0",
+    "vitest": "^5.0.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}