@esimplicity/stack-tests 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Internal Use Only License
+
+Copyright (c) Kata. All rights reserved.
+
+Permission is hereby granted to employees and contractors of Kata, and other authorized parties explicitly approved in writing by Kata, to use, copy, and modify this software solely for internal business purposes. Distribution, sublicensing, or use for any external or commercial purpose without prior written consent from Kata is prohibited.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+# @kata/stack-tests
+
+Reusable Playwright-BDD fixtures, ports, adapters, and step registrations for API, UI, and hybrid testing. Designed to be consumed as a dev dependency across repos.
+
+## Install
+
+GitHub Packages (recommended for release builds):
+
+```bash
+npm config set @kata:registry https://npm.pkg.github.com
+npm set //npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
+npm install -D @kata/stack-tests @playwright/test playwright-bdd
+```
+
+Workspace/local development (from this monorepo):
+
+```bash
+bun add -d @kata/stack-tests@"file:../packages/stack-tests" @playwright/test playwright-bdd
+```
+
+## What’s included
+
+- **Fixtures**: `createBddTest` wiring world, api/ui/auth/cleanup adapters.
+- **Ports**: `ApiPort`, `UiPort`, `AuthPort`, `CleanupPort`.
+- **Adapters**: Playwright API/UI adapters, default cleanup, example auth adapter.
+- **Step registrations**: API (auth/http/assertions), UI (basic + wizard), shared vars/cleanup, hybrid helpers.
+- **Config helpers**: tag expression helpers for project tagging.
+
+## Minimal usage
+
+1) Create fixtures (consumer repo):
+```ts
+// features/steps/fixtures.ts
+import {
+  createBddTest,
+  PlaywrightApiAdapter,
+  PlaywrightUiAdapter,
+  UniversalAuthAdapter,
+  DefaultCleanupAdapter,
+} from '@kata/stack-tests';
+
+export const test = createBddTest({
+  createApi: ({ apiRequest }) => new PlaywrightApiAdapter(apiRequest),
+  createUi: ({ page }) => new PlaywrightUiAdapter(page),
+  createAuth: ({ api, ui }) => new UniversalAuthAdapter({ api, ui }),
+  createCleanup: () => new DefaultCleanupAdapter(),
+});
+```
+
+2) Register steps (thin wrappers):
+```ts
+// features/steps/steps_api/index.ts
+import { test } from '../fixtures';
+import { registerApiSteps } from '@kata/stack-tests/steps';
+registerApiSteps(test);
+```
+
+3) Configure Playwright projects with your features/steps globs and tag expressions. Keep `@playwright/test` and `playwright-bdd` aligned with peer ranges.
+
+## Publishing (GitHub Packages)
+
+- Ensure `.npmrc` includes:
+  ```
+  @kata:registry=https://npm.pkg.github.com
+  //npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
+  ```
+- Build then publish:
+  ```bash
+  npm run build
+  npm publish --access public
+  ```
+  (Adjust access per your org policy.)
+
+## Notes
+- Peer dependencies: `@playwright/test`, `playwright-bdd`, `typescript` must be installed in the consuming repo.
+- Defaults (auth/cleanup) are examples; override via `createBddTest` options for app-specific behavior.
+- Tagging: supports `@api`, `@ui`, `@hybrid`, plus your own (`@smoke`, `@slow`, `@external`); combine with Playwright’s `maxFailures`/reporters as needed.