feat(typescript): move typescript variable instances from protractor/… (#3565)

Breaking change for TypeScript:

Instead of importing globals like `browser` from `protractor/globals`, import from `protractor`.

Before:

```ts
import {browser, element} from 'protractor/globals';
import {ElementFinder} from 'protractor';

describe('my app', () => {
  myElement: ElementFinder;

  beforeEach(() => {
    browser.get('example.com');
    myElement = element(by.css('foo'));
  });
});
```

After

```ts
import {browser, element, ElementFinder} from 'protractor';

describe('my app', () => {
  myElement: ElementFinder;

  beforeEach(() => {
    browser.get('example.com');
    myElement = element(by.css('foo'));
  });
});
```

Closes #3564

Author: juliemr

.gitignore

@@ -14,5 +14,4 @@ npm-debug.log
 .idea/
 
 *.swp
-globals.js
-globals.d.ts
+

.npmignore

@@ -19,4 +19,3 @@ libpeerconnection.log
 npm-debug.log
 xmloutput*
 release.md
-globals.ts

exampleTypescript/README.md

@@ -47,10 +47,10 @@ npm install
 
 ## Protractor typings
 
-To use Protractor types, you'll need to import `protractor/globals`. After this is imported, you should have autocompletion hints when typing.
+To use Protractor types, you'll need to import `protractor`. After this is imported, you should have autocompletion hints when typing.
 
 ```
-import {browser, element, by, By, $, $$, ExpectedConditions} from 'protractor/globals';
+import {browser, element, by, By, $, $$, ExpectedConditions} from 'protractor';
 ```
 
 Although the Protractor configuration file can be written in javascript, creating it in typescript will have some hints. These hints and the reference configuration can be found in `lib/config.ts`. Below we are importing the Config interface and applying that interface to the config variable:

exampleTypescript/angularPage.ts

@@ -4,7 +4,7 @@
 // import {browser, element, by, By, $, $$, ExpectedConditions}
 //   from 'protractor/globals';
 //
-import {browser, element, by} from 'protractor/globals';
+import {browser, element, by} from 'protractor';
 
 export class AngularHomepage {
   nameInput = element(by.model('yourName'));

exampleTypescript/spec.ts

@@ -5,7 +5,7 @@
 //   from 'protractor/globals';
 //
 // The jasmine typings are brought in via DefinitelyTyped ambient typings.
-import {browser, element, by, By, $, $$, ExpectedConditions} from 'protractor/globals';
+import {browser, element, by, By, $, $$, ExpectedConditions} from 'protractor';
 
 describe('protractor with typescript typings', () => {
   beforeEach(() => {

globals.ts

@@ -83,19 +83,14 @@ gulp.task('tsc', function(done) {
   runSpawn(done, 'node', ['node_modules/typescript/bin/tsc']);
 });
 
-gulp.task('tsc:globals', function(done) {
-  runSpawn(done, 'node', ['node_modules/typescript/bin/tsc', '-d', 'globals.ts'],
-    'ignore');
-});
-
 gulp.task('prepublish', function(done) {
-  runSequence('checkVersion', ['jshint', 'format'], 'tsc', 'tsc:globals',
+  runSequence('checkVersion', ['jshint', 'format'], 'tsc',
     'built:copy', done);
 });
 
 gulp.task('pretest', function(done) {
   runSequence('checkVersion',
-    ['webdriver:update', 'jshint', 'format'], 'tsc', 'tsc:globals',
+    ['webdriver:update', 'jshint', 'format'], 'tsc',
     'built:copy', done);
 });
 

gulpfile.js

@@ -0,0 +1,36 @@
+/// <reference path="../typings/index.d.ts" />
+
+// TODO: we'd like to remove the triple-slash reference, but it's necessary
+// until definitely-typed is updated for selenium-webdriver.
+
+import {ElementHelper, ProtractorBrowser} from './browser';
+import {ElementArrayFinder, ElementFinder} from './element';
+import {ProtractorExpectedConditions} from './expectedConditions';
+import {ProtractorBy} from './locators';
+import {Ptor} from './ptor';
+
+// Re-export public types.
+export {ElementHelper, ProtractorBrowser} from './browser';
+export {Config} from './config';
+export {ElementArrayFinder, ElementFinder} from './element';
+export {ProtractorExpectedConditions} from './expectedConditions';
+export {ProtractorBy} from './locators';
+export {Ptor} from './ptor';
+
+// Export API instances based on the global Protractor object.
+// We base this on NodeJS `global` because we do not want to mask
+// with a different instance of Protractor if the module is
+// installed both globally and locally.
+export let protractor: Ptor = (global as any)['protractor'];
+export let browser: ProtractorBrowser = protractor.browser;
+export let $: (search: string) => ElementFinder = protractor.$;
+export let $$: (search: string) => ElementArrayFinder = protractor.$$;
+export let element: ElementHelper = protractor.element;
+export let By: ProtractorBy = protractor.By;
+export let by: ProtractorBy = protractor.by;
+export let wrapDriver:
+    (webdriver: any, baseUrl?: string, rootElement?: string,
+     untrackOutstandingTimeouts?: boolean) => ProtractorBrowser =
+        protractor.wrapDriver;
+export let ExpectedConditions: ProtractorExpectedConditions =
+    protractor.ExpectedConditions;

lib/index.d.ts

@@ -2,3 +2,4 @@ node_modules
 typings
 conf.js
 typescript_spec.js
+npm-debug.log

lib/index.ts

@@ -1,5 +1,5 @@
-import {browser, by, By, element, $, $$, ExpectedConditions, protractor} from 'protractor/globals';
-import {ProtractorBrowser} from 'protractor';
+import {browser, by, By, element, $, $$, ExpectedConditions, protractor} from 'protractor';
+
 describe('typescript imports', () => {
   it('should have global objects that match the protractor namespace', () => {
     expect(protractor.browser === browser).toBeTruthy();

spec/install/.gitignore

@@ -20,8 +20,6 @@
     "testapp",
     "website",
     "scripts",
-    "globals.ts",
-    "globals.d.ts",
     "exampleTypescript",
     "typings/globals",
     "spec"