@cornerstonejs/nifti-volume-loader 2.11.6 → 2.12.0

package/README.md

@@ -1,3 +1,20 @@
 # @cornerstonejs/nifti-volume-loader
 
 Nifti volume loader for the cornerstone3D framework.
+
+# Injecting headers
+
+You can inject custom headers to the requests made by the loader. This is useful for authentication purposes.
+
+```js
+import { init } from '@cornerstonejs/nifti-volume-loader';
+
+niftiInit({
+  beforeSend: (xhr, headers, url) => {
+    headers['Cornerstone3D-Is-Awesome'] = 'True';
+    return headers;
+  },
+});
+```
+
+Now, every request made by the loader will have the `Cornerstone3D-Is-Awesome` header with the value `True`.

package/dist/esm/cornerstoneNiftiImageLoader.js

@@ -2,12 +2,23 @@ import { Enums, eventTarget, metaData, triggerEvent, utilities, } from '@corners
 import * as NiftiReader from 'nifti-reader-js';
 import { Events } from './enums';
 import { modalityScaleNifti } from './helpers';
+import { getOptions } from './internal';
 const dataFetchStateMap = new Map();
 function fetchArrayBuffer({ url, signal, onload, }) {
     return new Promise((resolve, reject) => {
         const xhr = new XMLHttpRequest();
         xhr.open('GET', url, true);
+        const defaultHeaders = {};
+        const options = getOptions();
+        const beforeSendHeaders = options.beforeSend(xhr, defaultHeaders, url);
+        const headers = Object.assign({}, defaultHeaders, beforeSendHeaders);
         xhr.responseType = 'arraybuffer';
+        Object.keys(headers).forEach(function (key) {
+            if (headers[key] === null) {
+                return;
+            }
+            xhr.setRequestHeader(key, headers[key]);
+        });
         const onLoadHandler = function (e) {
             if (onload && typeof onload === 'function') {
                 onload();

package/dist/esm/createNiftiImageIdsAndCacheMetadata.js

@@ -5,6 +5,7 @@ import Events from './enums/Events';
 import { NIFTI_LOADER_SCHEME } from './constants';
 import makeVolumeMetadata from './helpers/makeVolumeMetadata';
 import { getArrayConstructor } from './helpers/dataTypeCodeHelper';
+import { getOptions } from './internal';
 export const urlsMap = new Map();
 const NIFTI1_HEADER_SIZE = 348;
 const NIFTI2_HEADER_SIZE = 540;
@@ -18,8 +19,17 @@ export async function fetchArrayBuffer({ url, onProgress, controller, onLoad, on
     let contentLength;
     const receivedLength = 0;
     const signal = controller.signal;
+    const options = getOptions();
+    const defaultHeaders = {};
+    const beforeSendHeaders = options.beforeSend?.(null, defaultHeaders, url);
+    const headers = Object.assign({}, defaultHeaders, beforeSendHeaders);
+    Object.keys(headers).forEach(function (key) {
+        if (headers[key] === null) {
+            headers[key] = undefined;
+        }
+    });
     try {
-        const response = await fetch(url, { signal });
+        const response = await fetch(url, { signal, headers });
         if (!response.ok) {
             throw new Error(`HTTP error! status: ${response.status}`);
         }

package/dist/esm/index.d.ts

@@ -2,4 +2,5 @@ import cornerstoneNiftiImageLoader from './cornerstoneNiftiImageLoader';
 import * as helpers from './helpers';
 import * as Enums from './enums';
 import { createNiftiImageIdsAndCacheMetadata } from './createNiftiImageIdsAndCacheMetadata';
-export { cornerstoneNiftiImageLoader, helpers, Enums, createNiftiImageIdsAndCacheMetadata, };
+import init from './init';
+export { cornerstoneNiftiImageLoader, helpers, Enums, createNiftiImageIdsAndCacheMetadata, init, };

package/dist/esm/index.js

@@ -2,4 +2,5 @@ import cornerstoneNiftiImageLoader from './cornerstoneNiftiImageLoader';
 import * as helpers from './helpers';
 import * as Enums from './enums';
 import { createNiftiImageIdsAndCacheMetadata } from './createNiftiImageIdsAndCacheMetadata';
-export { cornerstoneNiftiImageLoader, helpers, Enums, createNiftiImageIdsAndCacheMetadata, };
+import init from './init';
+export { cornerstoneNiftiImageLoader, helpers, Enums, createNiftiImageIdsAndCacheMetadata, init, };

package/dist/esm/init.d.ts

@@ -0,0 +1,3 @@
+import type { LoaderOptions } from './types';
+declare function init(options?: LoaderOptions): void;
+export default init;

package/dist/esm/init.js

@@ -0,0 +1,5 @@
+import { setOptions } from './internal';
+function init(options = {}) {
+    setOptions(options);
+}
+export default init;

package/dist/esm/internal/index.d.ts

@@ -0,0 +1,2 @@
+import { setOptions, getOptions } from './options';
+export { setOptions, getOptions };

package/dist/esm/internal/index.js

@@ -0,0 +1,2 @@
+import { setOptions, getOptions } from './options';
+export { setOptions, getOptions };

package/dist/esm/internal/options.d.ts

@@ -0,0 +1,3 @@
+import type { LoaderOptions } from '../types';
+export declare function setOptions(newOptions: LoaderOptions): void;
+export declare function getOptions(): LoaderOptions;

package/dist/esm/internal/options.js

@@ -0,0 +1,10 @@
+let options = {
+    beforeSend() {
+    },
+};
+export function setOptions(newOptions) {
+    options = Object.assign(options, newOptions);
+}
+export function getOptions() {
+    return options;
+}

package/dist/esm/types/LoaderOptions.d.ts

@@ -0,0 +1,3 @@
+export interface LoaderOptions {
+    beforeSend?: (xhr: XMLHttpRequest, defaultHeaders: Record<string, string>, url: string) => Record<string, string> | void;
+}

package/dist/esm/types/index.d.ts

@@ -0,0 +1,2 @@
+import type { LoaderOptions } from './LoaderOptions';
+export type { LoaderOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/nifti-volume-loader",
-  "version": "2.11.6",
+  "version": "2.12.0",
   "description": "Nifti Image Loader for Cornerstone3D",
   "module": "./dist/esm/index.js",
   "types": "./dist/esm/index.d.ts",
@@ -61,7 +61,7 @@
     "nifti-reader-js": "^0.6.8"
   },
   "peerDependencies": {
-    "@cornerstonejs/core": "^2.11.6"
+    "@cornerstonejs/core": "^2.12.0"
   },
   "contributors": [
     {
@@ -74,5 +74,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "74bdf7c72095372dba54f898421aef2bfb52ee47"
+  "gitHead": "b922cdc85eba1e60b7a7bb6cb7d7309921aefcbe"
 }