@testspectra/cli 1.1.8-rc.3 → 1.1.8-rc.31

package/templates/default/support/actions/seedSession/mobile.action.ts

@@ -1,9 +1,9 @@
-export default async function (this: any) {
-  // Android has no cookie jar to write into — the deep link asks the app to log itself in
-  // (a known, sanctioned test account, server-side) and persist the result through its own
-  // secure storage (e.g. react-native-keychain), the same way a real login would. See
-  // docs/v2/features/authentication-and-session-seeding.md for why this doesn't accept an
-  // externally-supplied session value the way the web action does.
-  await this.navigate("testspectra-demo://seed-session");
-  await this.get("~auth-status-badge").waitForElement(10000);
-}
+export default async function (this: any) {
+  // Android has no cookie jar to write into — the deep link asks the app to log itself in
+  // (a known, sanctioned test account, server-side) and persist the result through its own
+  // secure storage (e.g. react-native-keychain), the same way a real login would. See
+  // docs/v2/features/authentication-and-session-seeding.md for why this doesn't accept an
+  // externally-supplied session value the way the web action does.
+  await this.navigate("testspectra-demo://seed-session");
+  await this.get("~auth-status-badge").waitForElement(10000);
+}

package/templates/default/support/actions/seedSession/web.action.ts

@@ -1,13 +1,13 @@
-export default async function (this: any) {
-  // Host-side (Bun) fetch — not the browser's — so there's no CORS/credentials restriction on
-  // reading the raw Set-Cookie header, HttpOnly included.
-  const res = await fetch("http://localhost:5200/api/login", {
-    method: "POST",
-    headers: { "content-type": "application/json" },
-    body: JSON.stringify({ email: "demo@testspectra.dev", password: "demo-password" }),
-  });
-  if (!res.ok) {
-    throw new Error(`seedSession: login failed (${res.status})`);
-  }
-  await this.browser.setCookies(res.headers.getSetCookie(), res.url);
-}
+export default async function (this: any) {
+  // Host-side (Bun) fetch — not the browser's — so there's no CORS/credentials restriction on
+  // reading the raw Set-Cookie header, HttpOnly included.
+  const res = await fetch("http://localhost:5200/api/login", {
+    method: "POST",
+    headers: { "content-type": "application/json" },
+    body: JSON.stringify({ email: "demo@testspectra.dev", password: "demo-password" }),
+  });
+  if (!res.ok) {
+    throw new Error(`seedSession: login failed (${res.status})`);
+  }
+  await this.browser.setCookies(res.headers.getSetCookie(), res.url);
+}

package/templates/default/support/steps/togglePlaygroundStates/mobile.step.ts

@@ -1,5 +1,5 @@
-export default async function () {
-  await PlaygroundPage.open();
-  await PlaygroundPage.hiddenElement.shouldBeVisible();
-  await PlaygroundPage.existingElement.shouldExist();
-}
+export default async function () {
+  await PlaygroundPage.open();
+  await PlaygroundPage.hiddenElement.shouldBeVisible();
+  await PlaygroundPage.existingElement.shouldExist();
+}

package/templates/default/support/steps/togglePlaygroundStates/web.step.ts

@@ -1,5 +1,5 @@
-export default async function () {
-  await PlaygroundPage.open();
-  await PlaygroundPage.hiddenElement.shouldBeVisible();
-  await PlaygroundPage.existingElement.shouldExist();
-}
+export default async function () {
+  await PlaygroundPage.open();
+  await PlaygroundPage.hiddenElement.shouldBeVisible();
+  await PlaygroundPage.existingElement.shouldExist();
+}

package/templates/default/support/steps/verifyPlaygroundState/mobile.step.ts

@@ -1,6 +1,6 @@
-export default async function () {
-  await PlaygroundPage.open();
-  await PlaygroundPage.visibleElement.shouldBeVisible();
-  await PlaygroundPage.enabledButton.shouldBeEnabled();
-  await PlaygroundPage.termsCheckbox.shouldBeChecked();
-}
+export default async function () {
+  await PlaygroundPage.open();
+  await PlaygroundPage.visibleElement.shouldBeVisible();
+  await PlaygroundPage.enabledButton.shouldBeEnabled();
+  await PlaygroundPage.termsCheckbox.shouldBeChecked();
+}

package/templates/default/support/steps/verifyPlaygroundState/web.step.ts

@@ -1,6 +1,6 @@
-export default async function () {
-  await PlaygroundPage.open();
-  await PlaygroundPage.visibleElement.shouldBeVisible();
-  await PlaygroundPage.enabledButton.shouldBeEnabled();
-  await PlaygroundPage.termsCheckbox.shouldBeChecked();
-}
+export default async function () {
+  await PlaygroundPage.open();
+  await PlaygroundPage.visibleElement.shouldBeVisible();
+  await PlaygroundPage.enabledButton.shouldBeEnabled();
+  await PlaygroundPage.termsCheckbox.shouldBeChecked();
+}

package/templates/docs/ARCHITECTURE.default.md

@@ -0,0 +1,26 @@
+# TestSpectra Project Architecture
+
+This project is built with the TestSpectra testing framework.
+
+## Structure & File Map
+- `./spectra.config.ts`: Typed runner configuration.
+- `./specs/`: Layered test cases (`specs/<Suite>/<CaseId>/` with `web.test.ts`, `android.test.ts`, `ios.test.ts`).
+- `./page-objects/`: Page Object models per platform.
+- `./support/steps/`: Business flows accessible globally via `Step.*`.
+- `./support/actions/`: Atomic actions accessible globally via `Spectra.*`.
+- `./fixtures/`: JSON fixtures accessible globally via `Fixture.*`.
+- `./global-hooks/`: Global suite lifecycle hooks.
+- `./.testspectra/`: Auto-generated ambient typings and local runtime cache.
+
+## Execution
+```bash
+# Run web test suite
+pnpm test
+
+# Run Android / iOS
+pnpm spectra run --target android
+pnpm spectra run --target ios
+
+# Type check
+pnpm type-check
+```

package/templates/docs/ARCHITECTURE.nx.md

@@ -0,0 +1,119 @@
+# TestSpectra Enterprise Monorepo Architecture
+
+This workspace uses TestSpectra's **"Centralized Configuration, Distributed Implementation"** model for automated cross-platform testing.
+
+---
+
+## 1. Directory & File Overview
+
+### Centralized Root Elements
+- `./spectra.config.ts`: Single source of truth for runtime configurations (Base URL, Appium devices, browser targets, timeouts).
+- `./.testspectra/`: Local test project cache, runtime metadata, auto-generated master TSConfig (`.testspectra/tsconfig.json`), platform sub-configs (`.testspectra/tsconfig/`), and universal ambient types (`.testspectra/types/`). Global binaries and drivers are managed at `~/.testspectra/drivers/`.
+- `./nx.json`: Nx target defaults with execution caching and inputs.
+- `./pnpm-workspace.yaml`: Monorepo package glob definitions.
+- `./tsconfig.json`: Solution-style TypeScript orchestrator referencing `./.testspectra/tsconfig.json`.
+
+### Centralized Shared Testing Library (`./__SHARED_TESTING_REL_PATH__`)
+Provides cross-feature reusable test entities with **100% zero-import global resolution**:
+- `page-objects/`: Shared Page Object models (e.g. NavigationBar, AppHeader).
+- `support/steps/`: Cross-feature business step flows (e.g. `Step.loginAsAdmin()`).
+- `support/actions/`: Custom atomic actions (e.g. `Spectra.dismissBanner()`).
+- `fixtures/`: Common test data and environment configurations (e.g. `Fixture.appConfig`).
+
+### Distributed Feature E2E Modules (__FEATURE_COUNT__ Features)
+__FEATURE_MODULES_SECTION__
+
+---
+
+## 2. Zero-Import Consumption Flow & Mechanics
+
+TestSpectra completely eliminates boilerplate `import` statements across all test specs, steps, and page objects.
+
+### How It Works:
+1. **Centralized Ambient Aggregation**:  
+   TestSpectra Language Service Plugin & CLI automatically scan:
+   - **Local Feature Entities**: `<feature>/__E2E_FOLDER_NAME__/page-objects/`, `<feature>/__E2E_FOLDER_NAME__/support/steps/`, `<feature>/__E2E_FOLDER_NAME__/support/actions/`
+   - **Shared Library Entities**: `./__SHARED_TESTING_REL_PATH__/page-objects/`, `./__SHARED_TESTING_REL_PATH__/support/steps/`, `./__SHARED_TESTING_REL_PATH__/support/actions/`, `./__SHARED_TESTING_REL_PATH__/fixtures/`
+2. **Ambient Typing Generation**:  
+   These are compiled into `.testspectra/types/web.d.ts`, `android.d.ts`, `ios.d.ts`, `fixtures.d.ts`.
+3. **Instant IDE Autocomplete & Zero Clutter**:  
+   Specs consume both local feature objects and shared library utilities globally.
+
+### Code Example:
+```typescript
+// packages/features/auth/e2e/specs/Auth/TC-AUTH-01/web.test.ts
+// 🌟 NOTICE: 100% Zero-Import & Flat Execution! (No import statement, no describe wrapper)
+
+it("should navigate via shared header and login with local POM", async () => {
+  // 1. Consumed from Shared Testing Library (__SHARED_TESTING_REL_PATH__/page-objects/NavigationBar)
+  await NavigationBar.goToLogin();
+
+  // 2. Consumed from Shared Testing Library (__SHARED_TESTING_REL_PATH__/support/steps/loginAsAdmin)
+  await Step.loginAsAdmin();
+
+  // 3. Consumed from Local Feature POM (page-objects/LoginPage)
+  await LoginPage.flashAlert.shouldBeVisible();
+  await LoginPage.flashAlert.shouldContainText("Welcome");
+
+  // 4. Consumed from Shared Testing Library Custom Action (__SHARED_TESTING_REL_PATH__/support/actions/dismissBanner)
+  await Spectra.dismissBanner();
+});
+```
+
+---
+
+## 3. How to Run Tests
+
+You can execute tests either from the **Monorepo Root via Nx** or directly inside each **Feature Directory via CLI**:
+
+### Option A: From Root Monorepo via Nx (Recommended for CI & Team Workflows)
+
+```bash
+# 1. Run E2E for a SPECIFIC feature module (e.g. auth)
+pnpm nx run auth-__E2E_FOLDER_NAME__:e2e
+
+# 2. Run E2E for a specific feature on ANDROID or IOS
+pnpm nx run auth-__E2E_FOLDER_NAME__:e2e --configuration=android
+pnpm nx run auth-__E2E_FOLDER_NAME__:e2e --configuration=ios
+
+# 3. Run E2E for a specific feature in HEADLESS browser mode
+pnpm nx run auth-__E2E_FOLDER_NAME__:e2e --configuration=headless
+
+# 4. Run ALL feature E2E suites across the entire monorepo in parallel
+pnpm nx run-many -t e2e
+
+# 5. Run only E2E tests for features modified in current Git branch / PR
+pnpm nx affected -t e2e
+```
+
+### Option B: From Inside the Feature Directory (Direct CLI)
+
+```bash
+# Navigate to the feature e2e folder
+cd __SAMPLE_FEATURE_E2E_PATH__
+
+# Run all specs in this feature
+pnpm spectra run
+
+# Run a specific test case by ID (platform is already picked via -t, no need for the file path)
+pnpm spectra run TC-AUTH-01 -t web
+
+# Target Android device or emulator
+pnpm spectra run --target android
+
+# Run in headed / interactive browser mode
+pnpm spectra run --no-headless
+```
+
+---
+
+## 4. Type Checking & Validation
+
+```bash
+# Type check all E2E projects via Nx
+pnpm nx run-many -t type-check
+
+# Or standard TypeScript project references build from root
+pnpm type-check
+# or: npx tsc -b
+```