Some cleanup of type definitions

Changes include:
 * removed definitions for non-public classes and functions
 * used interfaces as much as possible to define API shapes
 * added super-interface `StatementRunner` for `Session` and
   `Transaction` to define signature of `#run()` is one place
 * added license headers
 * applied default IntelliJ code formatter

Author: lutovich

src/v1/graph-types.js

@@ -17,6 +17,8 @@
  * limitations under the License.
  */
 
+import Integer from './integer';
+
 /**
  * Class for Node Type.
  */ 

src/v1/record.js

@@ -49,9 +49,8 @@ class Record {
    * Create a new record object.
    * @constructor
    * @access private
-   * @param {Object} keys An array of field keys, in the order the fields appear
-   *                      in the record
-   * @param {Object} fields An array of field values
+   * @param {string[]} keys An array of field keys, in the order the fields appear in the record
+   * @param {Array} fields An array of field values
    * @param {Object} fieldLookup An object of fieldName -> value index, used to map
    *                            field names to values. If this is null, one will be
    *                            generated.

types/index.d.ts

@@ -1,3 +1,23 @@
+/**
+ * Copyright (c) 2002-2017 "Neo Technology,","
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import * as v1 from "./v1/index";
-export { v1 }
+
+export {v1}
 export default v1;

types/v1/driver.d.ts

@@ -1,54 +1,61 @@
+/**
+ * Copyright (c) 2002-2017 "Neo Technology,","
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import Session from "./session";
-import Pool from "./internal/pool";
-import Integer from "./integer";
-import { connect, Connection } from "./internal/connector";
-import StreamObserver from "./internal/stream-observer";
-import { newError, SERVICE_UNAVAILABLE } from "./error";
+import {Parameters} from "./statement-runner";
 
-interface AuthCredentials {
+interface AuthToken {
   scheme: string;
   principal: string;
   credentials: string;
   realm?: string;
-  parameters?: { [key: string]: any };
+  parameters?: Parameters;
 }
 
-interface ConfigurationOptions {
-  encrypted?: string;
-  trust?: string;
-  trustedCertificates?: any[];
+type EncryptionLevel = "ENCRYPTION_ON" | "ENCRYPTION_OFF";
+type TrustStrategy =
+  "TRUST_ALL_CERTIFICATES" |
+  "TRUST_ON_FIRST_USE" |
+  "TRUST_SIGNED_CERTIFICATES" |
+  "TRUST_CUSTOM_CA_SIGNED_CERTIFICATES" |
+  "TRUST_SYSTEM_CA_SIGNED_CERTIFICATES";
+
+interface Config {
+  encrypted?: boolean | EncryptionLevel;
+  trust?: TrustStrategy;
+  trustedCertificates?: string[];
   knownHosts?: string;
+  connectionPoolSize?: number;
+  maxTransactionRetryTime?: number;
 }
 
-declare const READ: string;
-declare const WRITE: string;
-
-declare class Driver {
-  constructor(
-    url: string,
-    userAgent: string,
-    token: AuthCredentials,
-    config?: ConfigurationOptions
-  );
-
-  protected _destroyConnection(conn: Connection): void;
-  protected _acquireConnection(mode: string): PromiseLike<Connection>;
-  protected _createSession(connectionPromise: PromiseLike<Connection>, cb: Function): Session;
-  protected _createConnection(url: string,
-    release: (url: string, conn: Connection) => void
-  ): Connection;
-  static _validateConnection(conn: Connection): Boolean
-  session(mode?: string): Session;
-  close(): void;
-}
+type SessionMode = "READ" | "WRITE";
 
-declare class _ConnectionStreamObserver<T> extends StreamObserver<T> {
-  constructor(driver: Driver, conn: Connection);
+declare const READ: SessionMode;
+declare const WRITE: SessionMode;
 
-  onError(error: Error): void;
-  onCompleted(message: any): void;
+declare interface Driver {
+  session(mode?: SessionMode, bookmark?: string): Session;
+
+  close(): void;
 }
 
-export { Driver, READ, WRITE, AuthCredentials, ConfigurationOptions }
+export {Driver, READ, WRITE, AuthToken, Config}
 
 export default Driver;

types/v1/error.d.ts

@@ -1,7 +1,27 @@
+/**
+ * Copyright (c) 2002-2017 "Neo Technology,","
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 declare const SERVICE_UNAVAILABLE: string;
 declare const SESSION_EXPIRED: string;
+declare const PROTOCOL_ERROR: string;
 
-declare function newError(message: any, code: string): Neo4jError;
+declare function newError(message: any, code?: string): Neo4jError;
 
 declare class Neo4jError extends Error {
   code: string;
@@ -15,4 +35,5 @@ export {
   Neo4jError,
   SERVICE_UNAVAILABLE,
   SESSION_EXPIRED,
+  PROTOCOL_ERROR
 }

types/v1/graph-types.d.ts

@@ -1,62 +1,81 @@
+/**
+ * Copyright (c) 2002-2017 "Neo Technology,","
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import Integer from "./integer";
+
 declare class Node {
-  constructor(
-    identity: string,
-    labels: string[],
-    properties: Object
-  )
+  constructor(identity: Integer,
+              labels: string[],
+              properties: object)
 
   toString(): string;
 }
 
 declare class Relationship {
-  identity: string;
-  start: string;
-  end: string;
+  identity: Integer;
+  start: Integer;
+  end: Integer;
   type: string;
-  properties: Object;
+  properties: object;
 
-  constructor(
-    identity: string,
-    start: string,
-    end: string,
-    type: string,
-    properties: Object
-  );
+  constructor(identity: Integer,
+              start: Integer,
+              end: Integer,
+              type: string,
+              properties: object);
 
   toString(): string;
 }
 
 declare class UnboundRelationship {
-  identity: string;
+  identity: Integer;
   type: string;
-  properties: Object;
+  properties: object;
+
+  constructor(identity: Integer,
+              type: string,
+              properties: object);
 
-  constructor(
-    identity: string,
-    type: string,
-    properties: Object
-  );
+  bind(start: Integer, end: Integer): Relationship;
 
-  bind(start: string, end: string): Relationship;
   toString(): string;
 }
 
 declare class PathSegment {
-  start: string;
+  start: Node;
   rel: Relationship;
-  end: string;
+  end: Node;
 
-  constructor(
-    start: string,
-    rel: Relationship,
-    end: string
-  );
+  constructor(start: Node,
+              rel: Relationship,
+              end: Node);
 }
 
 declare class Path {
   start: Node;
   end: Node;
   segments: PathSegment[];
+  length: number;
+
+  constructor(start: Node,
+              end: Node,
+              segments: PathSegment[]);
 }
 
 export {