happo 5.0.0 → 6.0.0-beta.0

package/README.md

@@ -0,0 +1,147 @@
+# Happo
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An open source library for integrating with [happo.io](https://happo.io) - a visual regression testing platform that helps you catch unintended visual changes in your applications.
+
+## ⚠️ Active Development
+
+This library is currently under active development. Features and APIs may change between releases. Follow this repository to get notified about new releases and updates.
+
+## 📚 Documentation
+
+For comprehensive documentation, visit [docs.happo.io](https://docs.happo.io).
+
+## 🚀 Features
+
+- **CLI Tool**: Includes a command-line interface for easy integration
+- **Flexible Configuration**: Support for multiple configuration file formats
+- **TypeScript Support**: Built with TypeScript and provides full type definitions
+- **ES Modules**: Uses modern ES modules for better tree-shaking and performance
+- **Cross-Platform**: Works on all major operating systems
+
+## 📦 Installation
+
+```bash
+npm install happo --save-dev
+# or
+pnpm add happo --save-dev
+# or
+yarn add happo --dev
+```
+
+## 🛠️ Usage
+
+### Basic Configuration
+
+Create a `happo.config.ts` file in your project root:
+
+```typescript
+import { defineConfig } from 'happo';
+
+export default defineConfig({
+  apiKey: process.env.HAPPO_API_KEY!,
+  apiSecret: process.env.HAPPO_API_SECRET!,
+  targets: {
+    'chrome-desktop': {
+      browserType: 'chrome',
+      viewport: '1280x720',
+    },
+    'firefox-desktop': {
+      browserType: 'firefox',
+      viewport: '1280x720',
+    },
+    'ios-safari': {
+      browserType: 'ios-safari',
+    },
+  },
+});
+```
+
+### CLI Usage
+
+Run Happo using the CLI:
+
+```bash
+npx happo
+```
+
+The CLI will automatically find your configuration file and execute the visual regression tests.
+
+## 🔧 Configuration Options
+
+### Supported Configuration Files
+
+The library automatically detects configuration files in the following order:
+
+- `happo.config.js`
+- `happo.config.mjs`
+- `happo.config.cjs`
+- `happo.config.ts`
+- `happo.config.mts`
+- `happo.config.cts`
+
+### Key Configuration Properties
+
+- **`apiKey`** & **`apiSecret`**: Authentication credentials for happo.io
+- **`targets`**: Browser configurations for testing
+- **`project`**: Optional project name for multi-project accounts
+
+### Browser Targets
+
+Supported browser types:
+
+- **Desktop**: `chrome`, `firefox`, `edge`, `safari`, `accessibility`
+- **Mobile**: `ios-safari`, `ipad-safari`
+
+Each target supports advanced options like:
+
+- Viewport sizing
+- Maximum height/width
+- Color scheme preferences
+
+## 🧪 Testing
+
+This project uses Node.js built-in test runner:
+
+```bash
+npm test
+```
+
+## 🤝 Contributing
+
+Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+### Development Setup
+
+1. Clone the repository
+2. Install dependencies: `pnpm install`
+3. Build the project: `pnpm build`
+4. Run tests: `pnpm test` and `pnpm test:playwright`
+
+To run the tests you will need a `.env.local` file with some keys. Use
+`env.example` as a starting point.
+
+### Code Style
+
+- Uses ESLint for code linting
+- Prettier for code formatting
+- TypeScript for type safety
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🔗 Links
+
+- [Documentation](https://docs.happo.io)
+- [happo.io](https://happo.io)
+- [npm package](https://www.npmjs.com/package/happo)
+
+## 💡 Support
+
+For support and questions:
+
+- Check the [documentation](https://docs.happo.io)
+- Open an issue in this GitHub repository
+- Contact happo.io support at support@happo.io

package/dist/browser/applyConstructedStylesPatch.d.ts

@@ -0,0 +1,14 @@
+declare const recordedCSSSymbol: unique symbol;
+declare const isInstalledSymbol: unique symbol;
+interface ExtendedCSSStyleSheetConstructor {
+    new (options?: CSSStyleSheetInit): CSSStyleSheet;
+    [isInstalledSymbol]?: boolean;
+    prototype: CSSStyleSheet;
+}
+interface ExtendedWindow extends Window {
+    CSSStyleSheet: ExtendedCSSStyleSheetConstructor;
+}
+export declare function isExtendedWindow(w: Window): w is ExtendedWindow;
+export default function applyConstructedStylesPatch(win?: ExtendedWindow): void;
+export { recordedCSSSymbol };
+//# sourceMappingURL=applyConstructedStylesPatch.d.ts.map

package/dist/browser/applyConstructedStylesPatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"applyConstructedStylesPatch.d.ts","sourceRoot":"","sources":["../../src/browser/applyConstructedStylesPatch.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,iBAAiB,EAAE,OAAO,MAAmC,CAAC;AAEpE,QAAA,MAAM,iBAAiB,EAAE,OAAO,MAA8B,CAAC;AAS/D,UAAU,gCAAgC;IACxC,KAAK,OAAO,CAAC,EAAE,iBAAiB,GAAG,aAAa,CAAC;IACjD,CAAC,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC;IAC9B,SAAS,EAAE,aAAa,CAAC;CAC1B;AAGD,UAAU,cAAe,SAAQ,MAAM;IACrC,aAAa,EAAE,gCAAgC,CAAC;CACjD;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,IAAI,cAAc,CAK/D;AAwCD,MAAM,CAAC,OAAO,UAAU,2BAA2B,CACjD,GAAG,GAAE,cAAoD,GACxD,IAAI,CA+HN;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/browser/assertElement.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Throws if the element is not a valid Element instance, an array of elements,
+ * or a NodeList of elements.
+ */
+export default function assertElement(element: unknown, gt?: typeof globalThis): asserts element is Element | Array<Element> | NodeListOf<Element>;
+//# sourceMappingURL=assertElement.d.ts.map

package/dist/browser/assertElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertElement.d.ts","sourceRoot":"","sources":["../../src/browser/assertElement.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,OAAO,EAAE,OAAO,EAChB,EAAE,GAAE,OAAO,UAA8B,GACxC,OAAO,CAAC,OAAO,IAAI,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAuBnE"}

package/dist/browser/main.d.ts

@@ -0,0 +1,5 @@
+import type { WindowHappo } from '../isomorphic/types.ts';
+declare global {
+    var happo: WindowHappo | undefined;
+}
+//# sourceMappingURL=main.d.ts.map

package/dist/browser/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/browser/main.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAG1D,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;CACpC"}