Skip to content

Commit b5eb188

Browse files
authored
feat: merge adapters-internal into adapters package (#17)
- Move FirestoreAdapter from adapters-internal to adapters package - Add @google-cloud/firestore dependency to adapters - Add ./firestore subpath export to adapters package.json - Update all documentation to reference adapters instead of adapters-internal - Remove adapters-internal package directory - Update tsconfig.json and vitest.config.ts to remove adapters-internal references - All adapters (filesystem, Slack, Firestore) now in single package - Reduces maintenance overhead by consolidating packages BREAKING CHANGE: @lytics/playwright-adapters-internal is removed. Use @lytics/playwright-adapters/firestore instead.
1 parent fcf47c2 commit b5eb188

22 files changed

Lines changed: 186 additions & 485 deletions
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
"@lytics/playwright-adapters": major
3+
---
4+
5+
Merge `@lytics/playwright-adapters-internal` into `@lytics/playwright-adapters`
6+
7+
**Breaking Change:** The `@lytics/playwright-adapters-internal` package has been removed and merged into `@lytics/playwright-adapters`.
8+
9+
**Migration:**
10+
- **Before:** `import { FirestoreAdapter } from '@lytics/playwright-adapters-internal/firestore';`
11+
- **After:** `import { FirestoreAdapter } from '@lytics/playwright-adapters/firestore';`
12+
13+
All adapters (FilesystemAdapter, SlackAdapter, FirestoreAdapter) are now available in a single package, reducing maintenance overhead.

AGENTS.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ A TypeScript monorepo providing reusable Playwright testing components built aro
2222
packages/
2323
├── annotations/ # Annotation framework (PUBLIC npm)
2424
├── reporter/ # Core reporter (PUBLIC npm)
25-
├── adapters/ # Generic adapters (PUBLIC npm)
26-
├── adapters-internal/ # Firestore adapter (INTERNAL GitHub Packages)
27-
└── journey/ # Journey tools (INTERNAL GitHub Packages)
25+
├── adapters/ # Storage adapters (PUBLIC npm: filesystem, Slack, Firestore)
26+
└── journey/ # Journey tools (PUBLIC npm)
2827
```
2928

3029
### Package Details
@@ -33,9 +32,8 @@ packages/
3332
|---------|-----------|---------|
3433
| `@lytics/playwright-annotations` | Public npm | Annotation framework with validation |
3534
| `@lytics/playwright-reporter` | Public npm | Adapter-based reporter |
36-
| `@lytics/playwright-adapters` | Public npm | Generic adapters (filesystem, Slack) |
37-
| `@lytics/playwright-adapters-internal` | GitHub Packages | Firestore adapter (Lytics schema) |
38-
| `@lytics/playwright-journey` | GitHub Packages | Journey-driven test generation |
35+
| `@lytics/playwright-adapters` | Public npm | Storage adapters (filesystem, Slack, Firestore) |
36+
| `@lytics/playwright-journey` | Public npm | Journey-driven test generation |
3937

4038
## Setup Commands
4139

@@ -84,7 +82,6 @@ Packages with dependencies must be built in order. Turborepo handles this automa
8482
- `@lytics/playwright-annotations` - No dependencies (builds first)
8583
- `@lytics/playwright-reporter` - Depends on annotations
8684
- `@lytics/playwright-adapters` - Depends on reporter, annotations
87-
- `@lytics/playwright-adapters-internal` - Depends on reporter, annotations
8885
- `@lytics/playwright-journey` - Depends on annotations
8986

9087
**Critical:** Always run `pnpm build` before `pnpm typecheck` because TypeScript needs the built `.d.ts` files from dependencies.
@@ -219,9 +216,6 @@ pnpm changeset
219216
- `@lytics/playwright-annotations`
220217
- `@lytics/playwright-reporter`
221218
- `@lytics/playwright-adapters`
222-
223-
**Internal packages** → GitHub Packages:
224-
- `@lytics/playwright-adapters-internal`
225219
- `@lytics/playwright-journey`
226220

227221
## Package Architecture
@@ -247,10 +241,12 @@ Generic storage adapters:
247241
- `FilesystemAdapter` - Local JSON storage
248242
- `SlackAdapter` - Slack notifications
249243

250-
### Adapters-Internal Package
244+
### Adapters Package
251245

252-
Lytics-specific adapters:
253-
- `FirestoreAdapter` - Firestore with Lytics schema
246+
Storage adapters:
247+
- `FilesystemAdapter` - Local JSON storage
248+
- `SlackAdapter` - Slack notifications
249+
- `FirestoreAdapter` - Google Cloud Firestore storage
254250

255251
### Journey Package
256252

CLAUDE.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,13 @@ journey (depends on: annotations)
119119
- Provides a pluggable architecture for different storage backends via adapters
120120
- Collects and processes test results
121121

122-
3. **@lytics/playwright-adapters**: Generic storage adapters for the reporter.
122+
3. **@lytics/playwright-adapters**: Storage adapters for the reporter.
123123
- Filesystem adapter for storing results locally
124124
- Slack adapter for notifications
125+
- Firestore adapter for Google Cloud Firestore
125126
- Implements common interfaces for storage backends
126127

127-
4. **@lytics/playwright-adapters-internal**: Internal adapters specific to Lytics/Contentstack.
128-
- Firestore adapter with Lytics schema
129-
- Internal implementation details
130-
131-
5. **@lytics/playwright-journey**: Journey-driven test generation.
128+
4. **@lytics/playwright-journey**: Journey-driven test generation.
132129
- Higher-level abstractions for journey-based testing
133130
- Connects tests to user journeys and business requirements
134131

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,13 @@ Open-source, generic infrastructure for any Playwright project:
1616
|---------|-------------|---------|
1717
| [`@lytics/playwright-annotations`](./packages/annotations) | Annotation framework with validation & ESLint | ![npm](https://img.shields.io/npm/v/@lytics/playwright-annotations) |
1818
| [`@lytics/playwright-reporter`](./packages/reporter) | Adapter-based reporter with pluggable storage | ![npm](https://img.shields.io/npm/v/@lytics/playwright-reporter) |
19-
| [`@lytics/playwright-adapters`](./packages/adapters) | Generic storage adapters (filesystem, Slack) | ![npm](https://img.shields.io/npm/v/@lytics/playwright-adapters) |
19+
| [`@lytics/playwright-adapters`](./packages/adapters) | Storage adapters (filesystem, Slack, Firestore) | ![npm](https://img.shields.io/npm/v/@lytics/playwright-adapters) |
2020

21-
### Internal Packages (GitHub Packages)
21+
### Contentstack-Specific Packages
2222

23-
Lytics/Contentstack-specific workflows:
24-
25-
| Package | Description |
26-
|---------|-------------|
27-
| [`@lytics/playwright-adapters-internal`](./packages/adapters-internal) | Firestore adapter with Lytics schema |
28-
| [`@lytics/playwright-journey`](./packages/journey) | Journey-driven test generation |
23+
| Package | Description | Version |
24+
|---------|-------------|---------|
25+
| [`@lytics/playwright-journey`](./packages/journey) | Journey-driven test generation | ![npm](https://img.shields.io/npm/v/@lytics/playwright-journey) |
2926

3027
## 🚀 Quick Start
3128

docs/RELEASE_PROCESS.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -61,48 +61,6 @@ Packages without `publishConfig` are published to npm:
6161
}
6262
```
6363

64-
### Internal Packages (GitHub Packages)
65-
66-
Packages with `registry` configured are published to GitHub Packages:
67-
68-
```json
69-
{
70-
"name": "@lytics/playwright-adapters-internal",
71-
"publishConfig": {
72-
"registry": "https://npm.pkg.github.com",
73-
"access": "restricted"
74-
}
75-
}
76-
```
77-
78-
## Installing Internal Packages
79-
80-
To install packages from GitHub Packages, configure npm authentication:
81-
82-
### Option 1: Using GITHUB_TOKEN (CI/CD)
83-
84-
```bash
85-
# In your CI/CD environment
86-
echo "@lytics:registry=https://npm.pkg.github.com" >> .npmrc
87-
echo "//npm.pkg.github.com/:_authToken=$GITHUB_TOKEN" >> .npmrc
88-
```
89-
90-
### Option 2: Using Personal Access Token (Local)
91-
92-
Create `.npmrc` in your project:
93-
94-
```
95-
@lytics:registry=https://npm.pkg.github.com
96-
//npm.pkg.github.com/:_authToken=YOUR_PERSONAL_ACCESS_TOKEN
97-
```
98-
99-
**Note:** Add `.npmrc` to `.gitignore` if it contains tokens!
100-
101-
Then install:
102-
103-
```bash
104-
npm install @lytics/playwright-adapters-internal
105-
```
10664

10765
## Versioning Guidelines
10866

packages/adapters-internal/CHANGELOG.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)