Add TypeScript definitions for v6 packages

Author: notheotherben

.travis.yml

@@ -17,6 +17,7 @@ script:
 - yarn test:mail
 - yarn test:client
 - yarn test:helpers
+- yarn test:typescript
 notifications:
   hipchat:
     rooms:

package.json

@@ -20,7 +20,8 @@
     "mocha-clean": "^1.0.0",
     "mocha-sinon": "^2.0.0",
     "sinon": "^2.3.2",
-    "sinon-chai": "^2.10.0"
+    "sinon-chai": "^2.10.0",
+    "typescript": "~2.4.2"
   },
   "scripts": {
     "lint": "eslint . --fix",
@@ -30,6 +31,7 @@
     "test:helpers": "babel-node ./node_modules/istanbul/lib/cli cover ./node_modules/mocha/bin/_mocha \"packages/helpers/**/*.spec.js\"",
     "test:client": "babel-node ./node_modules/istanbul/lib/cli cover ./node_modules/mocha/bin/_mocha \"packages/client/**/*.spec.js\"",
     "test:mail": "babel-node ./node_modules/istanbul/lib/cli cover ./node_modules/mocha/bin/_mocha \"packages/mail/**/*.spec.js\"",
+    "test:typescript": "tsc",
     "test": "npm run test:all -s",
     "coverage": "open -a \"Google Chrome\" ./coverage/lcov-report/index.html"
   }

packages/client/index.d.ts

@@ -0,0 +1,3 @@
+import Client = require("@sendgrid/client/src/client");
+
+export = Client;

packages/client/package.json

@@ -28,7 +28,8 @@
   },
   "dependencies": {
     "@sendgrid/helpers": "^6.0.0",
-    "request": "^2.81.0"
+    "request": "^2.81.0",
+    "@types/request": "^2.0.3"
   },
   "tags": [
     "http",

packages/client/src/client.d.ts

@@ -0,0 +1,38 @@
+import {ResponseError} from "@sendgrid/helpers/classes";
+import {OptionsWithUrl} from "request";
+
+declare type ClientRequest = OptionsWithUrl;
+
+declare class Client {
+  /**
+   * Set API key
+   */
+  setApiKey(apiKey: string): void;
+
+  /**
+   * Set default header
+   */
+  setDefaultHeader(key: string, value: string): this;
+
+  /**
+   * Set default request
+   */
+  setDefaultRequest<K extends keyof ClientRequest>(key: K, value: ClientRequest[K]): this;
+
+  /**
+   * Create headers for request
+   */
+  createHeaders(data: { [key: string]: string }): { [key: string]: string };
+
+  /**
+   * Create request
+   */
+  createRequest(data: ClientRequest): ClientRequest;
+
+  /**
+   * Do a request
+   */
+  request(data: ClientRequest, cb?: (err: ResponseError, response: any[]) => void): Promise<any[]>;
+}
+
+export = new Client()

packages/client/yarn.lock

@@ -1,6 +1,27 @@
 # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 # yarn lockfile v1
+"@sendgrid/helpers@^6.0.0":
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/@sendgrid/helpers/-/helpers-6.0.0.tgz#b7ae9b927822e6a3a3e44abb2486e68d03e25220"
+  dependencies:
+    chalk "^2.0.1"
+
+"@types/form-data@*":
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/@types/form-data/-/form-data-2.2.0.tgz#a98aac91dc99857b6af24caef7ca6df302f31565"
+  dependencies:
+    "@types/node" "*"
 
+"@types/node@*":
+  version "8.0.25"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.25.tgz#66ecaf4df93f5281b48427ee96fbcdfc4f0cdce1"
+
+"@types/request@^2.0.3":
+  version "2.0.3"
+  resolved "https://registry.yarnpkg.com/@types/request/-/request-2.0.3.tgz#bdf0fba9488c822f77e97de3dd8fe357b2fb8c06"
+  dependencies:
+    "@types/form-data" "*"
+    "@types/node" "*"
 
 ajv@^4.9.1:
   version "4.11.8"
@@ -9,18 +30,24 @@ ajv@^4.9.1:
     co "^4.6.0"
     json-stable-stringify "^1.0.1"
 
+ansi-styles@^3.1.0:
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.0.tgz#c159b8d5be0f9e5a6f346dab94f16ce022161b88"
+  dependencies:
+    color-convert "^1.9.0"
+
 asn1@~0.2.3:
   version "0.2.3"
   resolved "https://registry.yarnpkg.com/asn1/-/asn1-0.2.3.tgz#dac8787713c9966849fc8180777ebe9c1ddf3b86"
 
-assert-plus@1.0.0, assert-plus@^1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-1.0.0.tgz#f12e0f3c5d77b0b1cdd9146942e4e96c1e4dd525"
-
 assert-plus@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-0.2.0.tgz#d74e1b87e7affc0db8aadb7021f3fe48101ab234"
 
+assert-plus@^1.0.0, assert-plus@1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-1.0.0.tgz#f12e0f3c5d77b0b1cdd9146942e4e96c1e4dd525"
+
 asynckit@^0.4.0:
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
@@ -49,10 +76,28 @@ caseless@~0.12.0:
   version "0.12.0"
   resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc"
 
+chalk@^2.0.1:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.1.0.tgz#ac5becf14fa21b99c6c92ca7a7d7cfd5b17e743e"
+  dependencies:
+    ansi-styles "^3.1.0"
+    escape-string-regexp "^1.0.5"
+    supports-color "^4.0.0"
+
 co@^4.6.0:
   version "4.6.0"
   resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
 
+color-convert@^1.9.0:
+  version "1.9.0"
+  resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.0.tgz#1accf97dd739b983bf994d56fec8f95853641b7a"
+  dependencies:
+    color-name "^1.1.1"
+
+color-name@^1.1.1:
+  version "1.1.3"
+  resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25"
+
 combined-stream@^1.0.5, combined-stream@~1.0.5:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.5.tgz#938370a57b4a51dea2c77c15d5c5fdf895164009"
@@ -81,6 +126,10 @@ ecc-jsbn@~0.1.1:
   dependencies:
     jsbn "~0.1.0"
 
+escape-string-regexp@^1.0.5:
+  version "1.0.5"
+  resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
+
 extend@~3.0.0:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.1.tgz#a755ea7bc1adfcc5a31ce7e762dbaadc5e636444"
@@ -118,6 +167,10 @@ har-validator@~4.2.1:
     ajv "^4.9.1"
     har-schema "^1.0.5"
 
+has-flag@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-2.0.0.tgz#e8207af1cc7b30d446cc70b734b5e8be18f88d51"
+
 hawk@~3.1.3:
   version "3.1.3"
   resolved "https://registry.yarnpkg.com/hawk/-/hawk-3.1.3.tgz#078444bd7c1640b0fe540d2c9b73d59678e8e1c4"
@@ -259,6 +312,12 @@ stringstream@~0.0.4:
   version "0.0.5"
   resolved "https://registry.yarnpkg.com/stringstream/-/stringstream-0.0.5.tgz#4e484cd4de5a0bbbee18e46307710a8a81621878"
 
+supports-color@^4.0.0:
+  version "4.2.1"
+  resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-4.2.1.tgz#65a4bb2631e90e02420dba5554c375a4754bb836"
+  dependencies:
+    has-flag "^2.0.0"
+
 tough-cookie@~2.3.0:
   version "2.3.2"
   resolved "https://registry.yarnpkg.com/tough-cookie/-/tough-cookie-2.3.2.tgz#f081f76e4c85720e6c37a5faced737150d84072a"
@@ -284,3 +343,4 @@ verror@1.3.6:
   resolved "https://registry.yarnpkg.com/verror/-/verror-1.3.6.tgz#cff5df12946d297d2baaefaa2689e25be01c005c"
   dependencies:
     extsprintf "1.0.2"
+

packages/contact-importer/index.d.ts

@@ -0,0 +1,3 @@
+import Importer = require("@sendgrid/contact-importer/src/importer");
+
+export = Importer;

packages/contact-importer/src/importer.d.ts

@@ -0,0 +1,30 @@
+declare interface ContactImporterOptions {
+    batchSize?: number;
+    rateLimitLimit?: number;
+    rateLimitPeriod?: number;
+}
+
+declare interface Contact {
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    age?: number;
+}
+
+declare class ContactImporter {
+    constructor(sg, options?: ContactImporterOptions);
+
+    push(data: Contact|Contact[])
+
+    on(event: "success", cb: (result: any, batch: Contact[]) => void): void;
+    on(event: "error", cb: (err: Error, batch?: Contact[]) => void): void;
+    on(event: "drain", cb: () => void): void;
+    on(event: string, cb: (data: any) => void): void;
+
+    once(event: "success", cb: (result: any, batch: Contact[]) => void): void;
+    once(event: "error", cb: (err: Error, batch?: Contact[]) => void): void;
+    once(event: "drain", cb: () => void): void;
+    once(event: string, cb: (data: any) => void): void;
+}
+
+export = ContactImporter;

packages/helpers/classes/attachment.d.ts

@@ -0,0 +1,27 @@
+export interface AttachmentData {
+  content: string;
+  filename: string;
+  type?: string;
+  disposition?: string;
+  contentId?: string;
+}
+
+export interface AttachmentJSON {
+  content: string;
+  filename: string;
+  type?: string;
+  disposition?: string;
+  content_id?: string;
+}
+
+export default class Attachment {
+  constructor(data?: AttachmentData);
+
+  fromData(data: AttachmentData): void;
+  setContent(content: string): void;
+  setFilename(filename: string): void;
+  setType(type: string): void;
+  setDisposition(disposition: string): void;
+  setContentId(contentId: string): void;
+  toJSON(): AttachmentJSON;
+}

packages/helpers/classes/email-address.d.ts

@@ -0,0 +1,24 @@
+export type EmailData = string|{ name?: string; email: string; }
+
+export type EmailJSON = { name?: string; email: string }
+
+export default class EmailAddress {
+  constructor(data?: EmailData);
+
+  /**
+   * From data
+   */
+  fromData(data: EmailData);
+
+  /**
+   * Set name
+   */
+  setName(name: string);
+
+  /**
+   * Set email (mandatory)
+   */
+  setEmail(email: string);
+
+  toJSON(): EmailJSON;
+}

packages/helpers/classes/index.d.ts

@@ -0,0 +1,13 @@
+import Attachment from "@sendgrid/helpers/classes/attachment";
+import EmailAddress from "@sendgrid/helpers/classes/email-address";
+import Mail from "@sendgrid/helpers/classes/mail"
+import Personalization from "@sendgrid/helpers/classes/personalization";
+import ResponseError from "@sendgrid/helpers/classes/response-error";
+
+export {
+  Attachment,
+  EmailAddress,
+  Mail,
+  Personalization,
+  ResponseError,
+}

packages/helpers/classes/mail.d.ts

@@ -0,0 +1,345 @@
+import {AttachmentData, AttachmentJSON} from "./attachment";
+import {EmailData, EmailJSON} from "./email-address";
+import Personalization from "./personalization";
+import {PersonalizationData, PersonalizationJSON} from "./personalization";
+
+export interface MailContent {
+  type: string;
+  value: string;
+}
+
+export interface ASMOptions {
+  groupId: number;
+  groupsToDisplay?: number[];
+}
+
+export interface ASMOptionsJSON {
+  group_id: number;
+  groups_to_display?: number[];
+}
+
+export interface MailSettings {
+  bcc?: {
+    enable?: boolean;
+    email?: string;
+  };
+  bypassListManagement?: {
+    enable?: boolean;
+  };
+  footer?: {
+    enable?: boolean;
+    text?: string;
+    html?: string;
+  };
+  sandboxMode?: {
+    enable?: boolean;
+  };
+  spamCheck?: {
+    enable?: boolean;
+    threshold?: number;
+    postToUrl?: string;
+  };
+}
+
+export interface MailSettingsJSON {
+  bcc?: {
+    enable?: boolean;
+    email?: string;
+  };
+  bypass_list_management?: {
+    enable?: boolean;
+  };
+  footer?: {
+    enable?: boolean;
+    text?: string;
+    html?: string;
+  };
+  sandbox_mode?: {
+    enable?: boolean;
+  };
+  spam_check?: {
+    enable?: boolean;
+    threshold?: number;
+    post_to_url?: string;
+  };
+}
+
+export interface TrackingSettings {
+  clickTracking?: {
+    enable?: boolean;
+    enableText?: boolean;
+  };
+  openTracking?: {
+    enable?: boolean;
+    substitutionTag?: string;
+  };
+  subscriptionTracking?: {
+    enable?: boolean;
+    text?: string;
+    html?: string;
+    substitutionTag?: string;
+  };
+  ganalytics?: {
+    enable?: boolean;
+    utmSource?: string;
+    utmMedium?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    utmCampaign?: string;
+  };
+}
+
+export interface TrackingSettingsJSON {
+  click_tracking?: {
+    enable?: boolean;
+    enable_text?: boolean;
+  };
+  open_tracking?: {
+    enable?: boolean;
+    substitution_tag?: string;
+  };
+  subscription_tracking?: {
+    enable?: boolean;
+    text?: string;
+    html?: string;
+    substitution_tag?: string;
+  };
+  ganalytics?: {
+    enable?: boolean;
+    utm_source?: string;
+    utm_medium?: string;
+    utm_term?: string;
+    utm_content?: string;
+    utm_campaign?: string;
+  };
+}
+
+export interface MailData {
+  to?: EmailData|EmailData[],
+  cc?: EmailData|EmailData[],
+  bcc?: EmailData|EmailData[],
+
+  from: EmailData,
+  replyTo?: EmailData,
+
+  sendAt?: number,
+
+  subject?: string,
+  text?: string,
+  html?: string,
+  content?: MailContent[],
+  templateId?: string,
+
+  personalizations?: PersonalizationData[],
+  attachments?: AttachmentData[],
+  
+  ipPoolName?: string,
+  batchId?: string,
+
+  sections?: { [key: string]: string },
+  headers?: { [key: string]: string },
+  
+  categories?: string[],
+  category?: string,
+  
+  customArgs?: { [key: string]: any },
+  asm?: ASMOptions,
+
+  mailSettings?: MailSettings,
+  trackingSettings?: TrackingSettings,
+  
+  substitutions?: { [key: string]: string },
+  substitutionWrappers?: string[],
+  
+  isMultiple?: boolean,
+}
+
+export interface MailJSON {
+  from: EmailJSON;
+  subject: string;
+  content: MailContent[];
+  personalizations: PersonalizationJSON[];
+  attachments?: AttachmentJSON[];
+  categories?: string[];
+  headers?: { [key: string]: string };
+  mail_settings?: MailSettingsJSON;
+  tracking_settings?: TrackingSettingsJSON;
+  custom_args?: { [key: string]: string };
+  sections?: { [key: string]: string };
+  asm?: ASMOptionsJSON;
+
+  reply_to?: EmailJSON;
+  send_at?: number;
+  batch_id?: string;
+  template_id?: string;
+  ip_pool_name?: string;
+}
+
+export default class Mail {
+  constructor(data?: MailData);
+
+  /**
+   * Build from data
+   */
+  fromData(data: MailData): void;
+
+  /**
+   * Set from email
+   */
+  setFrom(from: EmailData): void;
+
+  /**
+   * Set reply to
+   */
+  setReplyTo(replyTo: EmailData): void;
+
+  /**
+   * Set subject
+   */
+  setSubject(subject: string): void;
+
+  /**
+   * Set send at
+   */
+  setSendAt(sendAt: number): void;
+
+  /**
+   * Set template ID
+   */
+  setTemplateId(templateId: string): void;
+
+  /**
+   * Set batch ID
+   */
+  setBatchId(batchId: string): void;
+
+  /**
+   * Set IP pool name
+   */
+  setIpPoolName(ipPoolName: string): void;
+
+  /**
+   * Set ASM
+   */
+  setAsm(asm: ASMOptions): void;
+
+  /**
+   * Set personalizations
+   */
+  setPersonalizations(personalizations: PersonalizationData[]): void;
+
+  /**
+   * Add personalization
+   */
+  addPersonalization(personalization: PersonalizationData): void;
+
+  /**
+   * Convenience method for quickly creating personalizations
+   */
+  addTo(to: EmailData|EmailData[], cc: EmailData|EmailData[], bcc: EmailData|EmailData[]): void;
+
+  /**
+   * Set substitutions
+   */
+  setSubstitutions(substitutions: { [key: string]: string }): void;
+
+  /**
+   * Set substitution wrappers
+   */
+  setSubstitutionWrappers(wrappers: string[]): void;
+
+  /**
+   * Helper which applies globally set substitutions to personalizations
+   */
+  applySubstitutions(personalization: Personalization): void;
+
+  /**
+   * Set content
+   */
+  setContent(content: MailContent[]): void;
+
+  /**
+   * Add content
+   */
+  addContent(content: MailContent): void;
+
+  /**
+   * Add text content
+   */
+  addTextContent(text: string): void;
+
+  /**
+   * Add HTML content
+   */
+  addHtmlContent(html: string): void;
+
+  /**
+   * Set attachments
+   */
+  setAttachments(attachments: AttachmentData[]): void;
+
+  /**
+   * Add attachment
+   */
+  addAttachment(attachment: AttachmentData): void;
+
+  /**
+   * Set categories
+   */
+  setCategories(categories: string[]): void;
+
+  /**
+   * Add category
+   */
+  addCategory(category: string): void;
+
+  /**
+   * Set headers
+   */
+  setHeaders(headers: { [key: string]: string }): void;
+
+  /**
+   * Add a header
+   */
+  addHeader(key: string, value: string): void;
+
+  /**
+   * Set sections
+   */
+  setSections(sections: { [key: string]: string }): void;
+
+  /**
+   * Set custom args
+   */
+  setCustomArgs(customArgs: { [key: string]: string }): void;
+
+  /**
+   * Set tracking settings
+   */
+  setTrackingSettings(settings: TrackingSettings): void;
+
+  /**
+   * Set mail settings
+   */
+  setMailSettings(settings: MailSettings): void;
+
+  /**
+   * To JSON
+   */
+  toJSON(): MailJSON;
+
+  /**
+   * Create a Mail instance from given data
+   */
+  static create(data: MailData): Mail;
+
+  /**
+   * Create a Mail instance from given data
+   */
+  static create(data: Mail): Mail;
+
+  /**
+   * Create a Mail instance from given data
+   */
+  static create(data: MailData[]): Mail[];
+}

packages/helpers/classes/personalization.d.ts

@@ -0,0 +1,114 @@
+import {EmailData, EmailJSON} from "./email-address";
+
+export interface PersonalizationData {
+  to: EmailData|EmailData[],
+  cc?: EmailData|EmailData[],
+  bcc?: EmailData|EmailData[],
+  subject?: string;
+  headers?: { [key: string]: string };
+  substitutions?: { [key: string]: string };
+  customArgs?: { [key: string]: string };
+  sendAt?: number;
+}
+
+export interface PersonalizationJSON {
+  to: EmailJSON|EmailJSON[];
+  cc?: EmailJSON[];
+  bcc?: EmailJSON[];
+  headers?: { [key: string]: string; };
+  substitutions?: { [key: string]: string; };
+  custom_args?: { [key: string]: string; };
+  subject?: string;
+  send_at?: number;
+}
+
+export default class Personalization {
+  constructor(data?: PersonalizationData);
+
+  fromData(data: PersonalizationData): void;
+  
+  /**
+   * Set subject
+   */
+  setSubject(subject: string): void;
+
+  /**
+   * Set send at
+   */
+  setSendAt(sendAt: number): void;
+
+  /**
+   * Set to
+   */
+  setTo(to: EmailData|EmailData[]): void;
+
+  /**
+   * Add a single to
+   */
+  addTo(to: EmailData): void;
+
+  /**
+   * Set cc
+   */
+  setCc(cc: EmailData|EmailData[]): void;
+
+  /**
+   * Add a single cc
+   */
+  addCc(cc: EmailData): void;
+
+  /**
+   * Set bcc
+   */
+  setBcc(bcc: EmailData|EmailData[]): void;
+
+  /**
+   * Add a single bcc
+   */
+  addBcc(bcc: EmailData): void;
+
+  /**
+   * Set headers
+   */
+  setHeaders(headers: { [key: string]: string }): void;
+
+  /**
+   * Add a header
+   */
+  addHeader(key: string, value: string): void;
+
+  /**
+   * Set custom args
+   */
+  setCustomArgs(customArgs: { [key: string]: string }): void;
+
+  /**
+   * Add a custom arg
+   */
+  addCustomArg(key: string, value: string): void;
+
+  /**
+   * Set substitutions
+   */
+  setSubstitutions(substitutions: { [key: string]: string }): void;
+
+  /**
+   * Add a substitution
+   */
+  addSubstitution(key: string, value: string): void;
+
+  /**
+   * Reverse merge substitutions, preserving existing ones
+   */
+  reverseMergeSubstitutions(substitutions: { [key: string]: string }): void;
+
+  /**
+   * Set substitution wrappers
+   */
+  setSubstitutionWrappers(wrappers: string[]): void;
+
+  /**
+   * To JSON
+   */
+  toJSON(): PersonalizationJSON;
+}

packages/helpers/classes/response-error.d.ts

@@ -0,0 +1,8 @@
+export default class ResponseError extends Error {
+    code: number;
+    message: string;
+    response: {
+        headers: { [key: string]: string; };
+        body: string;
+    };
+}

packages/helpers/helpers/array-to-json.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Helper to convert an array of objects to JSON
+ */
+declare function arrayToJSON(arr: any[]): any[];
+
+export = arrayToJSON;

packages/helpers/helpers/convert-keys.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Helper to convert an object's keys
+ */
+declare function convertKeys<T extends {}, S extends {}>(obj: T, converter: (key: string) => string, ignored?: string[]): S;
+
+export = convertKeys;

packages/helpers/helpers/deep-clone.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Deep cloning helper for objects
+ */
+declare function deepClone<T>(obj: T): T;
+
+export = deepClone;

packages/helpers/helpers/index.d.ts

@@ -0,0 +1,19 @@
+import arrayToJSON = require("@sendgrid/helpers/helpers/array-to-json");
+import convertKeys = require("@sendgrid/helpers/helpers/convert-keys");
+import deepClone = require("@sendgrid/helpers/helpers/deep-clone");
+import mergeData = require("@sendgrid/helpers/helpers/merge-data");
+import splitNameEmail = require("@sendgrid/helpers/helpers/split-name-email");
+import toCamelCase = require("@sendgrid/helpers/helpers/to-camel-case");
+import toSnakeCase = require("@sendgrid/helpers/helpers/to-snake-case");
+import wrapSubstitutions = require("@sendgrid/helpers/helpers/wrap-substitutions");
+
+export {
+  arrayToJSON,
+  convertKeys,
+  deepClone,
+  mergeData,
+  splitNameEmail,
+  toCamelCase,
+  toSnakeCase,
+  wrapSubstitutions,
+}

packages/helpers/helpers/merge-data.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Merge data helper
+ */
+declare function mergeData<T, S>(base: T, data: S): T&S;
+
+export = mergeData;

packages/helpers/helpers/split-name-email.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Split name and email address from string
+ */
+declare function splitNameEmail(str: string): string[];
+
+export = splitNameEmail;

packages/helpers/helpers/to-camel-case.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Convert object keys to camel case
+ */
+declare function toCamelCase<T extends {}, S extends {}>(obj: T, ignored?: string[]): S;
+
+export = toCamelCase;

packages/helpers/helpers/to-snake-case.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Convert object keys to snake case
+ */
+declare function toSnakeCase<T extends {}, S extends {}>(obj: T, ignored?: string[]): S;
+
+export = toSnakeCase;

packages/helpers/helpers/wrap-substitutions.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Wrap substitutions
+ */
+declare function wrapSubstitutions(substitutions: { [key: string]: string }, left?: string, right?: string): { [key: string]: string };
+
+export = wrapSubstitutions;

packages/helpers/index.d.ts

@@ -0,0 +1,7 @@
+import * as helpers from "@sendgrid/helpers/helpers/index"
+import * as classes from "@sendgrid/helpers/classes/index"
+
+export {
+  helpers,
+  classes,
+};

packages/inbound-mail-parser/index.d.ts

@@ -0,0 +1,3 @@
+import * as Parser from "./src/parser";
+
+export = Parser;

packages/inbound-mail-parser/src/parser.d.ts

@@ -0,0 +1,41 @@
+import {Attachment} from "@sendgrid/helpers/classes"
+
+declare interface ParseConfig {
+  keys: string[];
+}
+
+declare interface ParseRequest {
+  body?: {};
+  files?: any[];
+}
+
+declare class Parse {
+  constructor(config: ParseConfig, request: ParseRequest);
+
+  /**
+   * Return an object literal of key/values in the payload received from webhook
+   * @return {Object} Valid key/values in the webhook payload
+   */
+  keyValues(): { [key: string]: any };
+
+  /**
+   * Whether the payload contains the raw email (Only applies to raw payloads)
+   * @return {Boolean}
+   */
+  hasRawEmail(): boolean;
+
+  /**
+   * Parses the raw email and returns the mail object in a callback (Only applies to raw payloads)
+   * @param {Function} callback Function which will receive the parsed email object as the sole argument
+   */
+  getRawEmail(callback: (mail: any) => void): void; 
+  // TODO: Type information for MailParser result in callback
+
+  /**
+   * Retrieves all attachments received from the webhook payload
+   * @param {Function} callback Function which will receive an array, of attachments found, as the sole argument
+   */
+  attachments(callback: (attachments: Attachment[]) => void): void;
+}
+
+export = Parse;

packages/mail/USE_CASES.md

@@ -444,7 +444,9 @@ const msg = {
     myCustomArg: 123,
   },
   batchId: 'sendgrid-batch-id',
-  asm: {},
+  asm: {
+    groupId: 1
+  },
   ipPoolName: 'sendgrid-ip-pool-name',
   mailSettings: {},
   trackingSettings: {},

packages/mail/index.d.ts

@@ -0,0 +1,3 @@
+import MailService = require("@sendgrid/mail/src/mail");
+
+export = MailService;

packages/mail/src/mail.d.ts

@@ -0,0 +1,32 @@
+import Client = require("@sendgrid/client");
+import {ResponseError} from "@sendgrid/helpers/classes";
+import {MailData} from "@sendgrid/helpers/classes/mail";
+
+declare class MailService {
+  /**
+   * API key pass through for convenience
+   */
+  setApiKey(apiKey: string): void;
+
+  /**
+   * Set substitution wrappers
+   */
+  setSubstitutionWrappers(left: string, right: string): void;
+
+  /**
+   * Send email
+   */
+  send(data: MailData, isMultiple?: boolean, cb?: (err: Error|ResponseError, result) => void): Promise<any>;
+
+  /**
+   * Send emails
+   */
+  send(data: MailData[], isMultiple?: boolean, cb?: (err: Error|ResponseError, result) => void): Promise<any>;
+
+  /**
+   * Send multiple emails (shortcut)
+   */
+  sendMultiple(data: MailData, cb?: (error: Error|ResponseError, result) => void): Promise<any>;
+}
+
+export = new MailService()

test/typescript/client.ts

@@ -0,0 +1,23 @@
+import Client = require("@sendgrid/client");
+
+// Test setApiKey() method
+Client.setApiKey("MY_SENDGRID_API_KEY");
+
+// Test setDefaultHeader() method
+Client.setDefaultHeader("X-Testing", "yes")
+      .setDefaultHeader("X-Testing-Type", "TypeScript");
+
+// Test setDefaultRequest() method
+Client.setDefaultRequest("method", "POST");
+Client.setDefaultRequest("method", "POST")
+      .setDefaultRequest("url", "/test");
+
+// Test createHeaders() method
+Client.createHeaders({
+  "X-Testing": "yes"
+});
+
+// Test createRequest() method
+const req = Client.createRequest({
+  url: "/test"
+});

test/typescript/helpers.ts

@@ -0,0 +1,22 @@
+import * as helpers from "@sendgrid/helpers";
+new helpers.classes.Attachment({
+    content: "",
+    filename: "test.txt",
+    type: "text/plain"
+});
+
+new helpers.classes.EmailAddress("someone@example.org");
+new helpers.classes.EmailAddress({ name: "Some One", email: "someone@example.org" });
+
+new helpers.classes.Personalization({
+    to: "someone@example.org",
+    subject: "Hello Some One"
+});
+
+new helpers.classes.Mail({
+    to: "someone@example.org",
+    from: "someone@example.org",
+    subject: "Hello Some One",
+    text: "This is a test message.",
+    html: "<p>This is a test message.</p>"
+});

test/typescript/mail.ts

@@ -0,0 +1,275 @@
+import sgMail = require("@sendgrid/mail");
+
+// Test setApiKey() method
+sgMail.setApiKey("MY_SENDGRID_API_KEY");
+
+// Test setSubstitutionWrappers() method
+sgMail.setSubstitutionWrappers("{{", "}}")
+
+// Test send() method
+sgMail.send({
+  from: "someone@example.org",
+  to: "Some One <someone@example.org>",
+  cc: { name: "Some One", email: "someone@example.org" },
+  subject: "Test Email",
+  text: "This is a test email",
+  html: "<p>This is a test email</p>"
+}).then(result => {
+  console.log("Sent email");
+}, err => {
+  console.error(err);
+});
+
+sgMail.send({
+  from: "someone@example.org",
+  to: "Some One <someone@example.org>",
+  cc: { name: "Some One", email: "someone@example.org" },
+  subject: "Test Email",
+  text: "This is a test email",
+  html: "<p>This is a test email</p>"
+}, false, (err) => {
+  if(err) console.error(err);
+  else console.log("Sent email");
+});
+
+// Test sendMultiple() method
+sgMail.sendMultiple({
+  from: "someone@example.org",
+  to: [
+    "Some One <someone@example.org>",
+    { name: "Some One", email: "someone@example.org" }
+  ],
+  cc: { name: "Some One", email: "someone@example.org" },
+  subject: "Test Email",
+  text: "This is a test email",
+  html: "<p>This is a test email</p>"
+}).then(result => {
+  console.log("Sent email");
+}, err => {
+  console.error(err);
+});
+
+sgMail.sendMultiple({
+  from: "someone@example.org",
+  to: [
+    "Some One <someone@example.org>",
+    { name: "Some One", email: "someone@example.org" }
+  ],
+  cc: { name: "Some One", email: "someone@example.org" },
+  subject: "Test Email",
+  text: "This is a test email",
+  html: "<p>This is a test email</p>"
+}, (err) => {
+  if(err) console.error(err);
+  else console.log("Sent email");
+});
+
+// Examples from the USE_CASES.md file
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello world',
+  text: 'Hello plain world!',
+  html: '<p>Hello HTML world!</p>',
+});
+
+sgMail.send({
+  to: ['recipient1@example.org', 'recipient2@example.org'],
+  from: 'sender@example.org',
+  subject: 'Hello world',
+  text: 'Hello plain world!',
+  html: '<p>Hello HTML world!</p>',
+});
+
+sgMail.sendMultiple({
+  to: ['recipient1@example.org', 'recipient2@example.org'],
+  from: 'sender@example.org',
+  subject: 'Hello world',
+  text: 'Hello plain world!',
+  html: '<p>Hello HTML world!</p>',
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  cc: 'someone@example.org',
+  bcc: ['me@example.org', 'you@example.org'],
+  from: 'sender@example.org',
+  replyTo: 'othersender@example.org',
+  subject: 'Hello world',
+  text: 'Hello plain world!',
+  html: '<p>Hello HTML world!</p>',
+});
+
+sgMail.send([
+  {
+    to: 'recipient1@example.org',
+    from: 'sender@example.org',
+    subject: 'Hello recipient 1',
+    text: 'Hello plain world!',
+    html: '<p>Hello HTML world!</p>',
+  },
+  {
+    to: 'recipient2@example.org',
+    from: 'other-sender@example.org',
+    subject: 'Hello recipient 2',
+    text: 'Hello other plain world!',
+    html: '<p>Hello other HTML world!</p>',
+  },
+]);
+
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello world',
+  text: 'Hello plain world!',
+  html: '<p>Hello HTML world!</p>',
+  templateId: '13b8f94f-bcae-4ec6-b752-70d6cb59f932',
+  substitutions: {
+    name: 'Some One',
+    city: 'Denver',
+  },
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello attachment',
+  html: '<p>Here’s an attachment for you!</p>',
+  attachments: [
+    {
+      content: 'Some base 64 encoded attachment content',
+      filename: 'some-attachment.txt',
+      type: 'plain/text',
+      disposition: 'attachment',
+      contentId: 'mytext'
+    },
+  ],
+});
+
+sgMail.send({
+  personalizations: [
+    {
+      to: 'recipient1@example.org',
+      subject: 'Hello recipient 1',
+      substitutions: {
+        name: 'Recipient 1',
+        id: '123',
+      },
+      headers: {
+        'X-Custom-Header': 'Recipient 1',
+      },
+      customArgs: {
+        myArg: 'Recipient 1',
+      },
+    },
+    {
+      to: 'recipient2@example.org',
+      subject: 'Hello recipient 2',
+      substitutions: {
+        name: 'Recipient 2',
+        id: '456',
+      },
+      headers: {
+        'X-Custom-Header': 'Recipient 2',
+      },
+      customArgs: {
+        myArg: 'Recipient 1',
+      },
+      sendAt: 1500077141,
+    }
+  ],
+  from: 'sender@example.org',
+  text: 'Hello plain world!',
+  html: '<p>Hello HTML world!</p>',
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello manual content',
+  content: [
+    {
+      type: 'text/html',
+      value: '<p>Hello HTML world!</p>',
+    },
+    {
+      type: 'text/plain',
+      value: 'Hello plain world!',
+    },
+  ],
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello custom header',
+  html: '<p>Some email content</p>',
+  headers: {
+    'X-CustomHeader': 'Custom header value',
+  },
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello delayed email',
+  html: '<p>Some email content</p>',
+  sendAt: 1500077141,
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello email with categories',
+  html: '<p>Some email content</p>',
+  categories: [
+    'transactional', 'customer', 'weekly',
+  ],
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  from: 'sender@example.org',
+  subject: 'Hello email with categories',
+  html: '<p>Some email content</p>',
+  category: 'transactional',
+});
+
+sgMail.send({
+  to: 'recipient@example.org',
+  cc: 'someone@example.org',
+  bcc: ['me@example.org', 'you@example.org'],
+  from: 'sender@example.org',
+  replyTo: 'othersender@example.org',
+  subject: 'Hello world',
+  text: 'Hello plain world!',
+  html: '<p>Hello HTML world!</p>',
+  templateId: 'sendgrid-template-id',
+  substitutionWrappers: ['{{', '}}'],
+  substitutions: {
+    name: 'Some One',
+    id: '123',
+  },
+  attachments: [
+    {
+      content: 'Some attachment content',
+      filename: 'some-attachment.txt',
+    },
+  ],
+  categories: ['Transactional', 'My category'],
+  sendAt: 1500077141,
+  headers: {
+    'X-CustomHeader': 'Custom header value',
+  },
+  sections: {},
+  customArgs: {
+    myCustomArg: 123,
+  },
+  batchId: 'sendgrid-batch-id',
+  asm: {
+    groupId: 1
+  },
+  ipPoolName: 'sendgrid-ip-pool-name',
+  mailSettings: {},
+  trackingSettings: {},
+});

tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "noEmit": true,
+        "module": "commonjs",
+        "target": "es6",
+        "baseUrl": ".",
+        "paths": {
+            "@sendgrid/*": ["packages/*"]
+        }
+    },
+    "include": [
+        "test/typescript/*.ts"
+    ]
+}