# protractor-e2e-framework > Protractor e2e framework Latest version **1.0.9** (published 2019-01-27) · ISC license · 0 weekly downloads ## Install ```sh npm install protractor-e2e-framework pnpm add protractor-e2e-framework yarn add protractor-e2e-framework bun add protractor-e2e-framework ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.9 | | Published | 2019-01-27 | | First published | 2018-03-30 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 4 | | Unpacked size | 91.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Morgan Pizzini | | Maintainers | morganpizzini | | Keywords | protractor, e2e, framework, typescript | ## Links - npm: https://www.npmjs.com/package/protractor-e2e-framework - Repository: https://github.com/morganpizzini/protractor-e2e-framework - Homepage: https://github.com/morganpizzini/protractor-e2e-framework#readme - Issues: https://github.com/morganpizzini/protractor-e2e-framework/issues - npm.io page: https://npm.io/package/protractor-e2e-framework ## Dependencies (4) - [lodash](https://npm.io/package/lodash.md) ^4.17.5 - [protractor](https://npm.io/package/protractor.md) ^5.3.0 - [ts-deferred](https://npm.io/package/ts-deferred.md) ^1.0.4 - [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.106 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 1.0.9 (latest) — 2019-01-27 - 1.0.7 — 2018-04-18 - 1.0.6 — 2018-04-05 - 1.0.5 — 2018-04-04 - 1.0.3 — 2018-04-03 - 1.0.2 — 2018-04-03 - 1.0.1 — 2018-04-03 - 0.0.5 — 2018-03-30 - 0.0.4 — 2018-03-30 - 0.0.3 — 2018-03-30 - 0.0.2 — 2018-03-30 - 0.0.1 — 2018-03-30 ## README # Protractor E2E Framework [![Build Status](https://travis-ci.org/morganpizzini/protractor-e2e-framework.svg?branch=master)](https://travis-ci.org/morganpizzini/protractor-e2e-framework) [![Coverage Status](https://coveralls.io/repos/github/morganpizzini/protractor-e2e-framework/badge.svg?branch=master)](https://coveralls.io/github/morganpizzini/protractor-e2e-framework?branch=master) Typescript library that interfaces with [protractor](https://github.com/angular/protractor) test development framework, offering some helpers and an automatic navigation interface by 'NavigationFlow' and a navigationRouteBook, which can change from test to test for define application navigation actions ## Installation install npm package ```markdown $ npm install --save-dev protractor-e2e-framework ``` ## Getting started ##### Define browser url schema model like ```markdown { "base": "/", "urls": { "base":"" "signIn" : "/account/sign-in", "home-page" : "/home", "post-detail-page" : "/posts/PostId-(\\d+)", .., .. }, "paramethers": { "PostId": "001", .., .. } } ``` each node defines * base page navigation url * each navigation page urls * navigation page urls paramethers * when ask for navigate to 'post-detail-page' the compiled url is **"/posts/PostId-001"** --- ##### Extends pages with BasePage ```markdown import { BasePage } from 'protractor-e2e-framework'; export class BasePage extends BasePage { constructor() { // set page's browser url key // in basePage/workflow acts like placeholder: "start from here" super('base'); } } ``` ```markdown import { BasePage } from 'protractor-e2e-framework'; export class SignInPage extends BasePage { constructor() { // set page's browser url key super('signIn'); } } ``` --- ##### Define navigations flows ```markdown import { NavigationBaseFlow, FrameworkConfiguration } from 'protractor-e2e-framework'; import { Deferred } from 'ts-deferred'; /** * base navigation flow */ export class BasePageNavigationFlow extends NavigationBaseFlow { /** * init base page navigation flow */ constructor() { // set workflow page super(BasePage); } /** * load browser default url */ public navigateTo(): Promise { const d: Deferred = new Deferred(); // navigation flow actions browser.get(FrameworkConfiguration.browserData.base).then(() => { d.resolve(this.pageInstance); }).catch(d.reject); return d.promise; } } /** * signIn navigation flow */ export class SignInPageNavigationFlow extends NavigationBaseFlow { /** * init signin page navigation flow */ constructor() { // set workflow page super(SignInPage); } /** * load signin page */ public navigateTo(): Promise { const d: Deferred = new Deferred(); //argument validation if (_.isEmpty(this.fromNavigationFlow)) { d.resolve(this.pageInstance); return d.promise; } // navigate to base navigation this.fromNavigationFlow.navigateTo().then((previousPage: BasePage) => { // navigation flow actions //do something with 'previousPage' for reach signInPage (like clicks, browser navigation ecc..) //resolve returning page d.resolve(this.pageInstance); }).catch(d.reject); return d.promise; } } ``` --- ##### Inside each 'beforeEach' functions ```markdown import { FrameworkConfiguration } from 'protractor-e2e-framework'; import { BasePageNavigationFlow, SignInPageNavigationFlow } from './navigation-flows'; const mockData = require('../resources/mockdata.json'); const browserData = require('../resources/browser-urls.json'); beforeEach(function() { // reset all previouis settings FrameworkConfiguration.reset(); // setup browser urls FrameworkConfiguration.browserData = browserData; // setup whatever mock datas you need FrameworkConfiguration.mockData = mockData; // #region navigation flows registrations // flowBook registration - can be done by 'from-to' funcion or by chain // for reach SignInPage i should navigate from BasePage FrameworkConfiguration.registerFlow('base', 'signIn'); // for reach HomePage i should navigate from BasePage then SignIn FrameworkConfiguration.registerFlow('base','signIn') .append('home-page'); // register by browser url id and type FrameworkConfiguration.registerType('base', BasePageNavigationFlow); FrameworkConfiguration.registerType('signIn', SignInPageNavigationFlow); // #endregion // runs with workflows FrameworkConfiguration.workflowNavigationEnabled = true; // runs with urls // FrameworkConfiguration.workflowNavigationEnabled = false; }); ``` --- ## Use in tests ```markdown it('should login', function (done) { let signInPage = new SignInPage(); // based on setups go to page url by workflows or url signInPage.goToPageUrl() .then(() => { // do login operations and expects }).catch(done.fail); }); ``` --- ### Problems? Please let us know If you run into any problems or issues, **please** let us know so we can address and fix them right away. You can report issues on GitHub: * [Protractor E2E Framework Bug Reports and Feature Requests](https://github.com/morganpizzini/protractor-e2e-framework/issues) --- _Source: https://npm.io/package/protractor-e2e-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._