Basic Typescript Type Definitions

[arcsector]

Summary

This PR serves to give basic support for Typescript to the SDK based off of the JSDoc spec, as well as suggesting configurations for devs looking to port their modules and code to Typescript.

Purpose

This PR is meant to assist with Typescript libraries looking to implement the SDK. This will further enable and widen the Splunk Dev community, as well as allow people to better understand the inner workings of the library.

Additions and Changes

• .gitignore
  • .vscode/ folder ignore for development
• README.md
  • Requirements
  • Typescript installation snippet
  • Typescript Service snippet
  • Recommended tsconfig.json example
  • Typescript /dist description
  • Typescript Link
• /dist
  • Typescript definition files based on JSDoc
• tsconfig.json
  • Compiler options and exclusions/inclusions for compiling Typescript type definitions
• package.json
  • Adding types key to tell Typescript where the Typescript files are supposed to be read from
• tslint.json
  • Establishes basic rules for Typescript linter

[arcsector]

What do i have to do to replicate the CI test? It really seems like the issue is mostly related to all the ES5-compatible exporting that you have to do in order to get Typescript to recognize the classes we're exporting (the export { Object }; at the end of each object file). Not sure what settings are causing the build to fail in the npm sdkdo hint command, but on my machine it gives a completely different error:

PS E:\Github_Repos\splunk-sdk-javascript> node sdkdo hint
E:\Github_Repos\splunk-sdk-javascript\sdkdo:26
        throw ex;
        ^

TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type undefined
    at validateString (internal/validators.js:112:11)
    at Object.join (path.js:375:7)
    at Object.interpret (E:\Github_Repos\splunk-sdk-javascript\node_modules\jshint\lib\cli.js:72:34)
    at Command.hint (E:\Github_Repos\splunk-sdk-javascript\bin\cli.js:762:16)
    at Command.<anonymous> (E:\Github_Repos\splunk-sdk-javascript\contrib\commander.js:308:8)
    at Command.parseArgs (E:\Github_Repos\splunk-sdk-javascript\contrib\commander.js:480:12)
    at Command.parse (E:\Github_Repos\splunk-sdk-javascript\contrib\commander.js:427:15)
    at E:\Github_Repos\splunk-sdk-javascript\bin\cli.js:841:13
    at Object.<anonymous> (E:\Github_Repos\splunk-sdk-javascript\bin\cli.js:846:3) {
  code: 'ERR_INVALID_ARG_TYPE'
}

And then, when running node jshint .

PS E:\Github_Repos\splunk-sdk-javascript> node jshint .
internal/modules/cjs/loader.js:796
    throw err;
    ^

Error: Cannot find module 'E:\Github_Repos\splunk-sdk-javascript\jshint'
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:793:17)
    at Function.Module._load (internal/modules/cjs/loader.js:686:27)
    at Function.Module.runMain (internal/modules/cjs/loader.js:1043:10)
    at internal/main/run_main_module.js:17:11 {
  code: 'MODULE_NOT_FOUND',
  requireStack: []
}

Not really sure how to make the CI build succeed if I can't troubleshoot locally...