refactor(ModmailConversationAuthor): convert to TS (not-an-aardvark#204)

* refactor(ModmailConversationAuthor): convert to TS

* Fixed docs for TS files

* Updated TSConfig to help JSDoc

package.json

@@ -13,7 +13,8 @@
     "test:mocha": "npm run compile && mocha --require @babel/register test/snoowrap.spec.js",
     "test:browser": "npm run compile && browserify --im test/snoowrap.spec.js -o test/_browser.spec.js -t [ babelify ] && open test/run-tests.html",
     "smoketest": "npm run test -- -g 'smoketest'",
-    "build-docs": "scripts/build_docs.sh",
+    "build-docs": "npm run build:docs",
+    "build:docs": "scripts/build_docs.sh",
     "build:babel": "babel -q -d dist/ src/",
     "build:types": "tsc -p tsconfig.gen-dts.json",
     "bundle-size": "npm run build-docs && gzip -c doc/snoowrap-v$(npm info . version).min.js | wc -c | xargs",

src/objects/ModmailConversationAuthor.js → src/objects/ModmailConversationAuthor.ts

@@ -1,4 +1,33 @@
 import RedditContent from './RedditContent';
+import RedditUser from './RedditUser';
+import * as Snoowrap from '../snoowrap';
+
+export interface BanStatus {
+  endDate?: string | null;
+  reason: string;
+  isBanned: boolean;
+  isPermanent: boolean;
+}
+
+export interface RecentPost {
+  date: string;
+  permalink: string;
+  title: string;
+}
+
+export interface RecentConvo {
+  date: string;
+  permalink: string;
+  id: string;
+  subject: string;
+}
+
+export interface RecentComment {
+  date: string;
+  permalink: string;
+  title: string;
+  comment: string;
+}
 
 /**
  * A class representing an author from a modmail conversation
@@ -9,8 +38,24 @@ import RedditContent from './RedditContent';
  * r.getNewModmailConversation('75hxt').getParticipant()
  * @extends RedditContent
  */
-const ModmailConversationAuthor = class ModmailParticipant extends RedditContent {
-  constructor (options, r, hasFetched) {
+export default class ModmailConversationAuthor extends RedditContent<ModmailConversationAuthor> {
+  name!: string;
+  isMod?: boolean;
+  isAdmin?: boolean;
+  isOp?: boolean;
+  isParticipant?: boolean;
+  isHidden?: boolean;
+  isDeleted?: boolean;
+
+  // these fields only show up sometimes
+  banStatus?: BanStatus;
+  isSuspended?: boolean;
+  isShadowBanned?: boolean;
+  recentPosts?: { [id: string]: RecentPost };
+  recentConvos?: { [id: string]: RecentConvo };
+  recentComments?: { [id: string]: RecentComment };
+
+  constructor (options: any, r: Snoowrap, hasFetched: boolean) {
     super(options, r, hasFetched);
 
     options.recentComments = Object.keys(options.recentComments).map(commentId => this._r._newObject('Comment', {
@@ -34,9 +79,7 @@ const ModmailConversationAuthor = class ModmailParticipant extends RedditContent
    * r.getNewModmailConversation('efy3lax').getParticipant().getUser().link_karma.then(console.log)
    * // => 6
    */
-  getUser () {
+  getUser (): Promise<RedditUser> {
     return this._r.getUser(this.name);
   }
 };
-
-export default ModmailConversationAuthor;

src/objects/RedditContent.d.ts

@@ -5,6 +5,9 @@ export default class RedditContent<T> extends Promise<T> {
   created: number;
   id: string;
   name: string;
+  protected _r: Snoowrap;
+  protected _fetch?: boolean;
+  protected _hasFetched: boolean;
 
   constructor(options: any, _r: Snoowrap, _hasFetched: boolean);
   fetch(): Promise<T>;

src/snoowrap.d.ts

@@ -32,6 +32,8 @@ export = Snoowrap;
 declare class Snoowrap {
   static getAuthUrl(options: Snoowrap.AuthUrlOptions): string;
   static fromAuthCode(options: Snoowrap.AuthCodeOptions): Promise<Snoowrap>;
+
+  _newObject (objectType: string, content: object[]|object, _hasFetched?: boolean): Array<unknown>|object;
   static noConflict(): typeof Snoowrap;
 
   accessToken: string;

tsconfig.json

@@ -1,8 +1,9 @@
 {
 	"compilerOptions": {
         "module": "commonjs",
+        "target": "es6",
         "lib": [
-            "es6",
+            "es2017",
             "dom"
         ],
         "noImplicitAny": true,