Merge pull request #61 from PaulHax/typed

Build typescript .d.ts files

.gitignore

@@ -64,3 +64,6 @@ yarn.lock
 
 # docker files created by the docker containers for testing
 tmp
+
+types/*
+!types/types.d.ts

package.json

@@ -4,11 +4,12 @@
   "description": "Implementation of DICOMweb client code",
   "main": "build/dicomweb-client.js",
   "module": "build/dicomweb-client.es.js",
+  "types": "types/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

@@ -33,6 +33,11 @@ const MEDIATYPES = {
   PNG: 'image/png',
 };
 
+
+/**
+ * @typedef { import("../types/types").InstanceMetadata } InstanceMetadata
+ */
+
 /**
  * A callback with the request instance and metadata information
  * of the currently request being executed that should necessarily
@@ -50,14 +55,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;
@@ -955,8 +960,8 @@ class DICOMwebClient {
    * Retrieves metadata for a DICOM study.
    *
    * @param {Object} options
-   * @param {Object} studyInstanceUID - Study Instance UID
-   * @returns {Object[]} Metadata elements in DICOM JSON format for each instance
+   * @param {String} options.studyInstanceUID - Study Instance UID
+   * @returns {Promise<InstanceMetadata[]>} Metadata elements in DICOM JSON format for each instance
                       belonging to the study
    */
   retrieveStudyMetadata(options) {
@@ -1007,9 +1012,9 @@ class DICOMwebClient {
    * Retrieves metadata for a DICOM series.
    *
    * @param {Object} options
-   * @param {Object} options.studyInstanceUID - Study Instance UID
-   * @param {Object} options.seriesInstanceUID - Series Instance UID
-   * @returns {Object[]} Metadata elements in DICOM JSON format for each instance
+   * @param {String} options.studyInstanceUID - Study Instance UID
+   * @param {String} options.seriesInstanceUID - Series Instance UID
+   * @returns {Promise<InstanceMetadata[]>} Metadata elements in DICOM JSON format for each instance
                       belonging to the series
    */
   retrieveSeriesMetadata(options) {
@@ -1041,8 +1046,8 @@ class DICOMwebClient {
    * Searches for DICOM Instances.
    *
    * @param {Object} options
-   * @param {Object} [options.studyInstanceUID] - Study Instance UID
-   * @param {Object} [options.seriesInstanceUID] - Series Instance UID
+   * @param {String} [options.studyInstanceUID] - Study Instance UID
+   * @param {String} [options.seriesInstanceUID] - Series Instance UID
    * @param {Object} [options.queryParams] - HTTP query parameters
    * @returns {Object[]} Instance representations (http://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_6.7.html#table_6.7.1-2b)
    */
@@ -1079,9 +1084,9 @@ class DICOMwebClient {
   /** Returns a WADO-URI URL for an instance
    *
    * @param {Object} options
-   * @param {Object} options.studyInstanceUID - Study Instance UID
-   * @param {Object} options.seriesInstanceUID - Series Instance UID
-   * @param {Object} options.sopInstanceUID - SOP Instance UID
+   * @param {String} options.studyInstanceUID - Study Instance UID
+   * @param {String} options.seriesInstanceUID - Series Instance UID
+   * @param {String} options.sopInstanceUID - SOP Instance UID
    * @returns {String} WADO-URI URL
    */
   buildInstanceWadoURIUrl(options) {
@@ -1118,7 +1123,7 @@ class DICOMwebClient {
    * @param {String} options.studyInstanceUID - Study Instance UID
    * @param {String} options.seriesInstanceUID - Series Instance UID
    * @param {String} options.sopInstanceUID - SOP Instance UID
-   * @returns {Object} metadata elements in DICOM JSON format
+   * @returns {Promise<InstanceMetadata>} metadata elements in DICOM JSON format
    */
   retrieveInstanceMetadata(options) {
     if (!('studyInstanceUID' in options)) {
@@ -1272,7 +1277,7 @@ class DICOMwebClient {
    * @param {String} options.sopInstanceUID - SOP Instance UID
    * @param {String[]} [options.mediaType] - Acceptable HTTP media types
    * @param {Object} [options.queryParams] - HTTP query parameters
-   * @returns {ArrayBuffer} Rendered DICOM Instance
+   * @returns {Promise<ArrayBuffer>} Rendered DICOM Instance
    */
   retrieveInstanceRendered(options) {
     if (!('studyInstanceUID' in options)) {
@@ -1582,7 +1587,7 @@ class DICOMwebClient {
    * @param {String} options.studyInstanceUID - Study Instance UID
    * @param {String} options.seriesInstanceUID - Series Instance UID
    * @param {String} options.sopInstanceUID - SOP Instance UID
-   * @returns {ArrayBuffer} DICOM Part 10 file as Arraybuffer
+   * @returns {Promise<ArrayBuffer>} DICOM Part 10 file as Arraybuffer
    */
   retrieveInstance(options) {
     if (!('studyInstanceUID' in options)) {
@@ -1626,7 +1631,8 @@ class DICOMwebClient {
    * @param {Object} options
    * @param {String} options.studyInstanceUID - Study Instance UID
    * @param {String} options.seriesInstanceUID - Series Instance UID
-   * @returns {ArrayBuffer[]} DICOM Instances
+   * @param {Function} options.progressCallback
+   * @returns {Promise<ArrayBuffer[]>} DICOM Instances
    */
   retrieveSeries(options) {
     if (!('studyInstanceUID' in options)) {

tsconfig.json

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