address comments

-  add comments
- remove gulpfile types task
- remove webdriver namespace from globals.d.ts

Author: cnishina

gulpfile.js

@@ -49,9 +49,10 @@ gulp.task('checkVersion', function(done) {
   }
 });
 
-gulp.task('built:copy', function() {
-  return gulp.src(['lib/**/*.js','lib/globals.d.ts'])
+gulp.task('built:copy', function(done) {
+  return gulp.src(['lib/**/*.js','lib/globals.d.ts','lib/index.d.ts'])
       .pipe(gulp.dest('built/'));
+  done();
 });
 
 gulp.task('webdriver:update', function(done) {
@@ -88,29 +89,14 @@ gulp.task('tsc:globals', function(done) {
 });
 
 gulp.task('prepublish', function(done) {
-  runSequence('checkVersion', ['jshint', 'format'], 'tsc', 'tsc:globals', 'types',
+  runSequence('checkVersion', ['jshint', 'format'], 'tsc', 'tsc:globals',
     'built:copy', done);
 });
 
 gulp.task('pretest', function(done) {
   runSequence('checkVersion',
     ['webdriver:update', 'jshint', 'format'], 'tsc', 'tsc:globals',
-    'types', 'built:copy', done);
+    'built:copy', done);
 });
 
 gulp.task('default',['prepublish']);
-
-gulp.task('types', function(done) {
-  var outputFile = path.resolve('built', 'index.d.ts');
-  var contents = '';
-  contents += '/// <reference path="../typings/index.d.ts" />\n';
-  contents += '/// <reference path="./globals.d.ts" />\n';
-  contents += 'export { ElementHelper, ProtractorBrowser } from \'./browser\';\n';
-  contents += 'export { ElementArrayFinder, ElementFinder } from \'./element\';\n';
-  contents += 'export { ProtractorExpectedConditions } from \'./expectedConditions\';\n';
-  contents += 'export { ProtractorBy } from \'./locators\';\n';
-  contents += 'export { Config } from \'./config\';\n';
-  contents += 'export { Ptor } from \'./ptor\';\n';
-  fs.writeFileSync(outputFile, contents);
-  done();
-});

lib/browser.ts

@@ -34,6 +34,7 @@ for (let foo in webdriver) {
 }
 
 // Explicitly define webdriver.WebDriver
+// TODO: extend WebDriver from selenium-webdriver typings
 export class Webdriver {
   actions: () => ActionSequence;
   call:
@@ -508,7 +509,7 @@ export class ProtractorBrowser extends Webdriver {
                     'Timed out waiting for Protractor to synchronize with ' +
                     'the page after ' + timeout + '. Please see ' +
                     'https://github.com/angular/protractor/blob/master/docs/faq.md';
-                if (description.startsWith(' - Locator: ')) {
+                if (description.indexOf(' - Locator: ') == 0) {
                   errMsg +=
                       '\nWhile waiting for element with locator' + description;
                 }
@@ -773,17 +774,14 @@ export class ProtractorBrowser extends Webdriver {
                       'return window.location.href;', msg('get url'))
                   .then(
                       (url: any) => { return url !== this.resetUrl; },
-                      (err: webdriver.ErrorCode) => {
+                      (err: IError) => {
                         if (err.code == 13) {
                           // Ignore the error, and continue trying. This is
-                          // because IE
-                          // driver sometimes (~1%) will throw an unknown error
-                          // from this
-                          // execution. See
+                          // because IE driver sometimes (~1%) will throw an
+                          // unknown error from this execution. See
                           // https://github.com/angular/protractor/issues/841
                           // This shouldn't mask errors because it will fail
-                          // with the timeout
-                          // anyway.
+                          // with the timeout anyway.
                           return false;
                         } else {
                           throw err;

lib/element.ts

@@ -18,6 +18,7 @@ let WEB_ELEMENT_FUNCTIONS = [
 ];
 
 // Explicitly define webdriver.WebElement.
+// TODO: extend WebElement from selenium-webdriver typings
 export class WebdriverWebElement {
   getDriver: () => WebDriver;
   getId: () => wdpromise.Promise<any>;

lib/globals.d.ts

@@ -13,6 +13,7 @@ declare namespace NodeJS {
   }
 
   interface Global {
+    // These are here because we tie these variables to the global namespace.
     browser: any;
     protractor: any;
     $: any;
@@ -24,7 +25,7 @@ declare namespace NodeJS {
     DartObject: any;
     Command: any;
     CommandName: any;
-    // Helper function added by the debugger in protractor.ps
+    // Helper function added by the debugger and element explorer
     list: (locator: any) => string[];
     [key: string]: any;
   }
@@ -35,12 +36,4 @@ declare interface IError extends Error {
   stack?: string;
 }
 
-declare interface String { startsWith: Function; }
-
-declare namespace webdriver {
-  class ErrorCode {
-    code: number;
-  }
-}
-
 declare interface HttpProxyAgent { constructor(opts: Object): HttpProxyAgent; }

lib/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference path="../typings/index.d.ts" />
+/// <reference path="./globals.d.ts" />
+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';