feat: build typescript .d.ts files

api.js changes:
- make most options to api.DICOMwebClient optional.
- add progressCallback arg to retrieveSeries

package.json

@@ -4,11 +4,12 @@
   "description": "Implementation of DICOMweb client code",
   "main": "build/dicomweb-client.js",
   "module": "build/dicomweb-client.es.js",
+  "types": "build/dicomweb-client.d.ts",
   "scripts": {
     "test": "./test_ci.sh",
     "test:watch": "./test.sh",
     "start": "rollup -c",
-    "build": "rollup -c",
+    "build": "rollup -c && npx tsc",
     "watch": "rollup -c -w",
     "version": "node -p -e \"'export default \\'' + require('./package.json').version + '\\';'\" > src/version.js",
     "lint": "eslint -c .eslintrc.js --fix src && prettier --write src/**/*.js"
@@ -44,7 +45,7 @@
     "prettier": "^1.16.4",
     "puppeteer": "^1.18.1",
     "rollup": "^0.63.2",
-    "rollup-plugin-babel": "^4.0.3"
-  },
-  "dependencies": {}
+    "rollup-plugin-babel": "^4.0.3",
+    "typescript": "^4.8.4"
+  }
 }

src/api.js

@@ -50,14 +50,14 @@ class DICOMwebClient {
    * @constructor
    * @param {Object} options
    * @param {String} options.url - URL of the DICOMweb RESTful Service endpoint
-   * @param {String} options.qidoURLPrefix - URL path prefix for QIDO-RS
-   * @param {String} options.wadoURLPrefix - URL path prefix for WADO-RS
-   * @param {String} options.stowURLPrefix - URL path prefix for STOW-RS
-   * @param {String} options.username - Username
-   * @param {String} options.password - Password
-   * @param {Object} options.headers - HTTP headers
-   * @param {Array.<RequestHook>} options.requestHooks - Request hooks.
-   * @param {Object} options.verbose - print to console request warnings and errors, default true
+   * @param {String=} options.qidoURLPrefix - URL path prefix for QIDO-RS
+   * @param {String=} options.wadoURLPrefix - URL path prefix for WADO-RS
+   * @param {String=} options.stowURLPrefix - URL path prefix for STOW-RS
+   * @param {String=} options.username - Username
+   * @param {String=} options.password - Password
+   * @param {Object=} options.headers - HTTP headers
+   * @param {Array.<RequestHook>=} options.requestHooks - Request hooks.
+   * @param {Object=} options.verbose - print to console request warnings and errors, default true
    */
   constructor(options) {
     this.baseURL = options.url;
@@ -1626,6 +1626,7 @@ class DICOMwebClient {
    * @param {Object} options
    * @param {String} options.studyInstanceUID - Study Instance UID
    * @param {String} options.seriesInstanceUID - Series Instance UID
+   * @param {Function} options.progressCallback
    * @returns {ArrayBuffer[]} DICOM Instances
    */
   retrieveSeries(options) {

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "build",
+    "declarationMap": true
+  }
+}