npm package: @openforge/dozn-plugin
Description: Dozn is a tool for automatically generating E2E tests for your application
Author: Openforge, LLC.
Latest version: 0.1.0

![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# Dozn Plugin

For full information and instructions, please refer to https://dozn.io.  However, since you are already here we'll give you a quick glance at what this plugin (and dozn) does!

## At a Glance

Dozn is a tool for automatically generating E2E Tests and visualizing your application.  Ever spend hours setiting up css selectors, only to have features change and E2E Tests become obsolete in your project? 

You're not the only one!

Dozn aims to change the way we utilize and think about E2E Testing.  Since (currently) many developers can't find the time to maintain their E2E Test Suite, we decided to change the way we think about E2E Tests.

## What this plugin captures

We do NOT capture your source code (check for yourself! #loveopensource). However, we do capture what's already public to end-users... the DOM!   The only exception to this is that we have you bootstrap your app so we can capture your Angular Controller names (i.e., "PageCtrl") as a string, as well as the version of your app.

This allows us to present your tests to you in a way you'll understand, instead of random guesses at what a page is called.   If you have a "LoginCtrl", then the buttons on the login page will be listed under "LoginCtrl" page.

## Using this component

### Script tag

- Put `<script src='https://unpkg.com/@openforge/dozn-plugin/dist/dozn.js'></script>` in the head of your index.html
- Then you can use the element like this:
```html
<dozn-plugin></dozn-plugin>
```

### Node Modules
- Run `npm install @openforge/dozn-plugin --save`
- Put a script tag similar to this `<script src='node_modules/@openforge/dozn-plugin/dist/dozn.js></script>` in the head of your index.html
- Then you can use the element like this:
```html
<dozn-plugin></dozn-plugin>
```

### In a stencil-starter app
- Run `npm install @openforge/dozn-plugin --save`
- Add an import to the npm packages: `import @openforge/dozn-plugin;`
- Then you can use the element like this:
```html
<dozn-plugin></dozn-plugin>
```

### In a angular app
- Run `npm install @openforge/dozn-plugin --save`
- Add `CUSTOM_ELEMENTS_SCHEMA` to your `AppModule`
- Add the import of defineCustomElements `import { defineCustomElements } from '@openforge/dozn-plugin';` and add the defineCustomElements call `defineCustomElements(window);` to your `main.ts`. Further info [here](https://stenciljs.com/docs/angular)
- Then you can use the element like this:
```html
<dozn-plugin></dozn-plugin>
```

## Parameters

### key

The Dozn Plugin needs the kep for the project, in order to get your key, sign up for an account at https://dozn.io
```html
<dozn-plugin key="MY_KEY"></dozn-plugin>
```

### version

This will be the version from the project that you are testing to filter by later on dozn.
```html
<dozn-plugin version="0.0.1"></dozn-plugin>
```