feat(typescript): add TypeScript annotations

package.json

@@ -3,6 +3,7 @@
   "version": "2.3.1",
   "description": "Pact for all things Javascript",
   "main": "./src/pact.js",
+  "types": "./src/pact.d.ts",
   "scripts": {
     "clean": "rimraf docs dist coverage logs pacts jscpd.json",
     "coverage": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",

src/common/config.d.ts

@@ -0,0 +1,9 @@
+interface Config {
+  mockService: {
+    host: string;
+    port: number;
+  };
+  logging: boolean;
+}
+
+export = Config;

src/common/logger.d.ts

@@ -0,0 +1 @@
+export function info(msg: string): void;

src/common/net.d.ts

@@ -0,0 +1 @@
+export function isPortAvailable(port: number, host: string): Promise<void>;

src/common/request.d.ts

@@ -0,0 +1,6 @@
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+
+export class Request {
+  constructor ();
+  send (method: HTTPMethod, url: string, body: string): Promise<string>;
+}

src/dsl/interaction.d.ts

@@ -0,0 +1,32 @@
+import {HTTPMethod} from '../common/request';
+import {MatcherResult} from './matchers';
+
+export class Interaction {
+  constructor();
+  given(providerState: string): Interaction;
+  uponReceiving(description: string): Interaction;
+  withRequest(requestOpts: RequestOptions): Interaction;
+  willRespondWith(responseOpts: ResponseOptions): Interaction;
+  json(): object;
+}
+
+export interface RequestOptions {
+  method: HTTPMethod;
+  path: string | MatcherResult;
+  query?: any;
+  headers?: {[name: string]: string | MatcherResult};
+  body?: any;
+}
+
+export interface ResponseOptions {
+  status: number | MatcherResult;
+  headers?: {[name: string]: string | MatcherResult};
+  body?: any;
+}
+
+export interface InteractionObject {
+  state: string;
+  uponReceiving: string;
+  withRequest: RequestOptions;
+  willRespondWith: ResponseOptions;
+}

src/dsl/matchers.d.ts

@@ -0,0 +1,26 @@
+export interface MatcherResult {
+  json_class: string;
+}
+
+export function term(opts: {generate: string, matcher: string}): {
+  json_class: 'Pact::Term',
+  data: {
+    generate: string,
+    matcher: {
+      json_class: 'Regexp',
+      o: 0,
+      s: string,
+    },
+  },
+};
+
+export function eachLike<T>(content: T, opts?: {min: number}): {
+  json_class: 'Pact::ArrayLike',
+  contents: T,
+  min: number,
+};
+
+export function somethingLike<T>(value: T): {
+  json_class: 'Pact::SomethingLike',
+  contents: T,
+};

src/dsl/matchers.js

@@ -35,7 +35,7 @@ module.exports.term = (opts) => {
 
 /**
  * The eachLike matcher
- * @param {string} content
+ * @param {any} content
  * @param {Object} opts
  * @param {Number} opts.min
  */
@@ -57,7 +57,7 @@ module.exports.eachLike = (content, opts) => {
 
 /**
  * The somethingLike matcher
- * @param {string} value - the value to be somethingLike
+ * @param {any} value - the value to be somethingLike
  */
 module.exports.somethingLike = (value) => {
   if (isNil(value) || isFunction(value)) {

src/dsl/mockService.d.ts

@@ -0,0 +1,9 @@
+import {Interaction} from './interaction';
+
+export class MockService {
+  constructor (consumer: string, provider: string, port?: number, host?: string, ssl?: boolean);
+  addInteraction(interaction: Interaction): Promise<string>;
+  removeInteractions(): Promise<string>;
+  verify(): Promise<string>;
+  writePact(): Promise<string>;
+}

src/dsl/verifier.d.ts

@@ -0,0 +1,2 @@
+declare function verifyProvider(opts: any): Promise<void>;
+export = verifyProvider;

src/pact-karma.d.ts

@@ -0,0 +1,26 @@
+import {InteractionObject} from "./dsl/interaction";
+import * as _Matchers from "./dsl/matchers";
+
+declare function pact(opts: pact.PactKarmaOptions): pact.PactKarmaProvider;
+
+declare namespace pact {
+  export interface PactKarmaOptions {
+    consumer: string;
+    provider: string;
+    port?: number;
+    host?: string;
+    ssl?: boolean;
+  }
+
+  export interface PactKarmaProvider {
+    addInteraction(interactionObj: InteractionObject): Promise<string>;
+    verify(): Promise<void>;
+    finalize(): Promise<void>;
+    writePact(): Promise<string>;
+    removeInteractions(): Promise<string>;
+  }
+
+  export const Matchers: typeof _Matchers;
+}
+
+export = pact;

src/pact.d.ts

@@ -0,0 +1,36 @@
+import {InteractionObject} from "./dsl/interaction";
+import * as _Matchers from "./dsl/matchers";
+import _Verifier = require("./dsl/verifier");
+
+declare function pact(opts: pact.PactOptions): pact.PactProvider;
+
+declare namespace pact {
+  export interface PactOptions {
+    consumer: string;
+    provider: string;
+    port?: number;
+    host?: string;
+    ssl?: boolean;
+    sslcert?: string;
+    sslkey?: string;
+    dir?: string;
+    log?: string;
+    logLevel?: string;
+    spec?: number;
+    cors?: boolean;
+  }
+
+  export interface PactProvider {
+    setup(): Promise<void>;
+    addInteraction(interactionObj: InteractionObject): Promise<string>;
+    verify(): Promise<void>;
+    finalize(): Promise<void>;
+    writePact(): Promise<string>;
+    removeInteractions(): Promise<string>;
+  }
+
+  export const Matchers: typeof _Matchers;
+  export const Verifier: typeof _Verifier;
+}
+
+export = pact;

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "noImplicitUseStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strictNullChecks": true
+  }
+}